云脑链接器获取资源列表 - ListDomainAllResource
功能介绍
云脑链接器获取资源列表
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/resource-manager/domains/{domain_id}/all-resources/{region_id}/{resource_type}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| domain_id | 是 | String | 参数解释: 账户ID。 通过调用IAM服务[查询IAM用户详情]接口获取 约束限制: 不涉及 取值范围: 以IAM服务[查询IAM用户详情]接口值为准。 默认取值: 不涉及 |
| resource_type | 是 | String | 参数解释: 资源类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| region_id | 是 | String | 参数解释: 以当前region id为准 约束限制: 不涉及 取值范围: 以当前region id为准 默认取值: 以当前region id为准 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 每页条数 约束限制: 正整数 取值范围: 大于0,小于等于100 默认取值: 100 |
| marker | 否 | String | 参数解释: 分页下一页标志位 约束限制: 以列表查询接口返回为准 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: IAM服务查询用户Token接口为准 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| page_info | PageInfo object | 分页信息 |
| resources | Array of CsbResource objects | 资源列表 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| tags | Array of CsbResourceTag objects | 资源标签 |
| affected_resources | Array of AffectedResource objects | 防护资源对象列表 |
| create_time | String | 创建时间 |
| description | String | 资源描述 |
| environment | ResourceEnvironment object | 资源环境属性 |
| name | String | 资源名称 |
| provider | String | 所属云服务,dbss |
| resource_id | String | 资源ID |
| security_group_id | String | 安全组ID |
| subnet_id | String | 子网ID |
| type | String | 资源类型 |
| update_time | String | 更新时间 |
| urn | String | 资源URN |
| urnext | String | 资源URN扩展 |
| vpc_id | String | VPC ID |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| affected_attached_domain_id | String | 被防护对象账户ID |
| affected_attached_project_id | String | 被防护对象项目ID |
| affected_head | DataResourceHead object | 被防护对象头部信息 |
| affected_properties | Object | 资源扩展信息 |
| affected_protected_id | String | 被防护(受影响)对象在防线系统内唯一ID |
| affected_subtype | String | 被防护(受影响)对象子类型: 固定为:DB |
| affected_type | String | 被防护(受影响)对象类型,数据库资产,固定为:Data |
| affected_urn | String | 被防护对象urn |
| affected_urnext | String | 被防护对象URN扩展 |
| affected_value | String | 被防护(受影响)对象值,云下数据库同affectedProtectedId,云上不传 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| alias | String | 数据库实例别名 |
| datastore | DbDataStore object | 数据库对象 |
| db_ip | String | 数据库IP |
| db_name | String | 数据库名称 |
| db_port | String | 数据库端口 |
| db_user_list | Array of DbUser objects | 数据库用户列表 |
| provider | String | 云服务名称,云上数据库服务,如:rds |
| rds_id | String | rds数据库ID |
| status | String | 数据库状态 |
| type | String | 数据库类型 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| domain_id | String | 账户ID |
| ep_id | String | 企业项目ID |
| ep_name | String | 企业项目名称 |
| project_id | String | 项目ID |
| region_id | String | regionID |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| details | Array of DbssErrorDetail objects | PDP5鉴权异常信息 |
| encoded_authorization_message | String | PDP5鉴权异常信息 |
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| details | Array of DbssErrorDetail objects | PDP5鉴权异常信息 |
| encoded_authorization_message | String | PDP5鉴权异常信息 |
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| details | Array of DbssErrorDetail objects | PDP5鉴权异常信息 |
| encoded_authorization_message | String | PDP5鉴权异常信息 |
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| details | Array of DbssErrorDetail objects | PDP5鉴权异常信息 |
| encoded_authorization_message | String | PDP5鉴权异常信息 |
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
请求示例
/v1/resource-manager/domains/{domain_id}/all-resources/{region_id}/{resource_type} 响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | 请求参数有误。 |
| 401 | 认证失败 |
| 403 | 未授权 |
| 500 | 服务端错误 |
错误码
请参见错误码。