查询企业项目绑定的资源列表
功能介绍
查询企业项目下绑定的资源详情。
调用方法
请参见如何调用API。
URI
POST /v1.0/enterprise-projects/{enterprise_project_id}/resources/filter
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| enterprise_project_id | 是 | String | 企业项目ID |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。说明:由于EPS是全局服务,因此调用IAM服务获取用户Token接口时需要注意作用域即scope字段应该设置为domain。响应消息头中X-Subject-Token的值即为用户Token。 |
| X-Security-Token | 否 | String | 如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| projects | 否 | Array of strings | 项目ID列表。resource_types中包含region级别服务时为必选项。 |
| resource_types | 是 | Array of strings | 资源类型列表, 此参数为可输入的值(区分大小写)。例如:ecs, scaling_group, images, disk, vpcs, security-groups, shared_bandwidth, eip, cdn等,具体请参见“查询企业项目支持的服务”章节。 |
| offset | 否 | Integer | 索引位置, 从offset指定的下一条数据开始查询,必须为数字,不能为负数,默认为0。 |
| limit | 否 | Integer | 查询记录数,不传默认为1000,limit最多为1000, 最小值为1。 |
| matches | 否 | Array of Match objects | 搜索字段,key为要匹配的字段,固定为resource_name,value为匹配的值,不传则表示无匹配条件。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| resources | Array of Resources objects | 资源列表 |
| errors | Array of Errors objects | 查询失败的企业项目下的资源 |
| total_count | Integer | 企业项目下的资源总数 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| enterprise_project_id | String | 企业项目ID |
| project_id | String | ProjectID |
| project_name | String | Project名称 |
| resource_detail | Object | 资源详情 |
| resource_id | String | 资源ID |
| resource_name | String | 资源名称 |
| resource_type | String | 资源类型 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误描述 |
| project_id | String | ProjectID |
| resource_type | String | 资源类型 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 错误请求信息 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 错误请求信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:402
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 错误请求信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 错误请求信息 |
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
| encoded_authorization_message | String | 编码 (加密) 后的详细拒绝原因 |
| details | Array of RespErrorMessage objects | PDP5错误信息及依赖云服务错误信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 错误请求信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:405
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 错误请求信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:406
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 错误请求信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:407
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 错误请求信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:408
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 错误请求信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:409
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 错误请求信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 错误请求信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:501
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 错误请求信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:502
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 错误请求信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:503
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 错误请求信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:504
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error | RespErrorMessage object | 错误请求信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
请求示例
查询企业项目的资源
POST https://{Endpoint}/v1.0/enterprise-projects/{enterprise_project_id}/resources/filter
{
"projects" : [ "e1eb7c40cbea4c8389cde527594a306d", "2345d321da864d6faf2e762647e19f96" ],
"resource_types" : [ "disk" ],
"offset" : 0,
"limit" : 10,
"matches" : [ {
"key" : "resource_name",
"value" : "lhj"
} ]
} 响应示例
状态码:200
OK
{
"resources" : [ {
"project_id" : "e1eb7c40cbea4c8389cde527594a306d",
"project_name" : "XXXX",
"resource_type" : "disk",
"resource_id" : "b621f5ae-b5c1-49d7-a660-752c445434b4",
"resource_name" : "lhj1-volume-0001",
"resource_detail" : null,
"enterprise_project_id" : "0"
}, {
"project_id" : "e1eb7c40cbea4c8389cde527594a306d",
"project_name" : "XXXX",
"resource_type" : "disk",
"resource_id" : "87c9edc9-f66c-48b8-a22f-372b2e22d579",
"resource_name" : "lhj2-volume-0002",
"resource_detail" : null,
"enterprise_project_id" : "0"
} ],
"errors" : [ ],
"total_count" : 2
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 402 | Payment Required |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 407 | Proxy Authentication Required |
| 408 | Request Timeout |
| 409 | Conflict |
| 500 | Internal Server Error |
| 501 | Not Implemented |
| 502 | Bad Gateway |
| 503 | Service Unavailable |
| 504 | Gateway Timeout |
错误码
请参见错误码。