更新时间:2022-07-18 GMT+08:00
分享

查询企业项目绑定的资源列表

功能介绍

查询企业项目下绑定的资源详情。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v1.0/enterprise-projects/{enterprise_project_id}/resources/filter

表1 路径参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。说明:由于EPS是全局服务,因此调用IAM服务获取用户Token接口时需要注意作用域即scope字段应该设置为domain。响应消息头中X-Subject-Token的值即为用户Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

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为匹配的值,不传则表示无匹配条件。

表4 Match

参数

是否必选

参数类型

描述

key

String

键。有matches参数时,该字段为必填,固定为resource_name。

value

String

值。即资源名称,有matches参数时,该字段为必填,且默认为模糊搜索,如”message.com”。每个值最大长度255个字符。

最大长度:255

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

resources

Array of Resources objects

资源列表

errors

Array of Errors objects

查询失败的企业项目下的资源

total_count

Integer

企业项目下的资源总数

表6 Resources

参数

参数类型

描述

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

资源类型

表7 Errors

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

project_id

String

ProjectID

resource_type

String

资源类型

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表9 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 401

表10 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表11 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 402

表12 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表13 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 403

表14 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表15 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 404

表16 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表17 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 405

表18 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表19 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 406

表20 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表21 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 407

表22 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表23 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 408

表24 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表25 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 409

表26 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表27 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 500

表28 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表29 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 501

表30 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表31 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 502

表32 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表33 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 503

表34 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表35 RespErrorMessage

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 504

表36 响应Body参数

参数

参数类型

描述

error

RespErrorMessage object

错误请求信息

表37 RespErrorMessage

参数

参数类型

描述

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

错误码

请参见错误码

分享:

    相关文档

    相关产品

close