查询资源底层实例列表 - ListResourceInstances
功能介绍
功能介绍:查询专区内指定资源的底层实例列表,返回分页结果。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/data-security-zones/{zone_id}/resources/{resource_id}/instances
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID 约束限制: 满足正则匹配"^[a-z0-9]{32}$" 取值范围: 32个字符,由数字和字母组成 默认取值: 不涉及 |
| zone_id | 是 | String | 参数解释: 专区ID 约束限制: 长度1~64字符 取值范围: 不涉及 默认取值: 不涉及 |
| resource_id | 是 | String | 参数解释: 资源ID 约束限制: 长度1~64字符 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 每页数量限制 约束限制: 最小值1,最大值1000 取值范围: 不涉及 默认取值: 不涉及 |
| marker | 否 | String | 参数解释: 分页游标 约束限制: 无下一页时为null 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 参数解释: 实例总数 取值范围: 不涉及 |
| limit | Integer | 参数解释: 本次返回条数 取值范围: 不涉及 |
| next_marker | String | 参数解释: 下一页游标 取值范围: 不涉及 |
| instances | Array of ResourceInstanceItem objects | 参数解释: 实例列表 取值范围: 不涉及 |
请求示例
查询实例列表
/v1/da211edc7bac01a07182af742e04dc6d/data-security-zones/zone-001/resources/res-001/instances?limit=10
响应示例
状态码:200
{
"total" : 1,
"limit" : 10,
"next_marker" : null,
"instances" : [ {
"instance_id" : "ins-001",
"instance_name" : "test-instance",
"instance_type" : "OBS"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功 |
错误码
请参见错误码。