查询资产列表 - ListAssets
功能介绍
功能介绍:查询资产列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/metadata/assets
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,字符长度32-32。 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | String | 参数解释: 每页数量限制 约束限制: 不涉及 取值范围: 1到256个字符 默认取值: 10 |
| offset | 否 | String | 参数解释: 分页偏移 约束限制: 不涉及 取值范围: 1到256个字符 默认取值: 1 |
| label_id | 否 | String | 参数解释: 标签ID 约束限制: 不涉及 取值范围: 1到256个字符 默认取值: 不涉及 |
| name | 否 | String | 参数解释: 资产名称 约束限制: 不涉及 取值范围: 1到256个字符 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: IAM服务查询用户Token接口为准 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 参数解释: 总记录数 取值范围: 不涉及 |
| instance_infos | Array of InstanceInfo objects | 参数解释: 实例信息列表 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
| name | String | 参数解释: 实例名称 取值范围: 不涉及 |
| type | Integer | 参数解释: 实例类型 取值范围: 不涉及 |
| description | String | 参数解释: 资源描述信息 取值范围: 不涉及 |
| status | Integer | 参数解释: 操作结果状态 取值范围: 不涉及 |
| task_status | String | 参数解释: 实例子任务状态 取值范围: 不涉及 |
| region_id | String | 参数解释: 实例所在Region标识 取值范围: 不涉及 |
| availability_zone_id | String | 参数解释: 可用区标识 取值范围: 不涉及 |
| version | String | 参数解释: 实例版本 取值范围: 不涉及 |
| latest_version | String | 参数解释: 最新版本 取值范围: 不涉及 |
| vpc_id | String | 参数解释: 虚拟私有云ID 取值范围: 不涉及 |
| vpc_name | String | 参数解释: VPC名称 取值范围: 不涉及 |
| subnet_id | String | 参数解释: 子网ID 取值范围: 不涉及 |
| subnet_name | String | 参数解释: 子网名称 取值范围: 不涉及 |
| security_group_id | String | 参数解释: 安全组ID 取值范围: 不涉及 |
| security_group_name | String | 参数解释: 租户侧的安全组名称 取值范围: 不涉及 |
| public_ip | String | 参数解释: 公共IP地址 取值范围: 不涉及 |
| private_ip | String | 参数解释: ECS私网IP 取值范围: 不涉及 |
| specification | String | 参数解释: 规格 取值范围: 不涉及 |
| server_id | String | 参数解释: 资源ID 取值范围: 不涉及 |
| resource_id | String | 参数解释: 资源ID 取值范围: 不涉及 |
| fail_reason | String | 参数解释: 失败原因 取值范围: 不涉及 |
| created_time | Long | 参数解释: 创建时间 取值范围: 不涉及 |
| started_time | Long | 参数解释: 实例启动时间 取值范围: 不涉及 |
| expired_time | Long | 参数解释: 过期时间 取值范围: 不涉及 |
| specification_cpu | String | 参数解释: 规格内存 取值范围: 不涉及 |
| specification_mem | String | 参数解释: 规格CPU核心数 取值范围: 不涉及 |
| specification_disk | String | 参数解释: 规格磁盘 取值范围: 不涉及 |
| public_ip_id | String | 参数解释: 弹性公网IP ID 取值范围: 不涉及 |
| db_infos | Array of strings | 参数解释: 数据库信息列表 取值范围: 不涉及 |
| instance_id | String | 参数解释: 实例ID 取值范围: 不涉及 |
| instance_name | String | 参数解释: 实例名称 取值范围: 不涉及 |
请求示例
查询资产列表
/v1/2b31ed520xxxxxxebedb6e57xxxxxxxx/metadata/assets
响应示例
状态码:200
{
"total" : 1,
"instance_infos" : [ {
"id" : "0cfd1d3e-2c4a-4d1f-8e2b-9a3c4d5e6f70",
"name" : "asset-resource-01",
"type" : 1,
"description" : "资产中心数据资源描述",
"status" : "ENABLE",
"task_status" : "FINISHED",
"region_id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"availability_zone_id" : "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908",
"version" : "1.0.0",
"latest_version" : "1.0.0",
"vpc_id" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d",
"vpc_name" : "asset-vpc-01",
"subnet_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
"subnet_name" : "asset-subnet-01",
"security_group_id" : "0cfd1d3e-2c4a-4d1f-8e2b-9a3c4d5e6f70",
"security_group_name" : "asset-sg-01",
"public_ip" : "192.168.1.100",
"private_ip" : "192.168.1.100",
"specification" : "asset-value-01",
"server_id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"resource_id" : "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908",
"fail_reason" : "asset-value-01",
"created_time" : 1700000000000,
"started_time" : 1700000000000,
"expired_time" : 1700000000000,
"specification_cpu" : "asset-value-01",
"specification_mem" : "asset-value-01",
"specification_disk" : "asset-value-01",
"public_ip_id" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。