文档首页> 企业管理> API参考（吉隆坡区域）> 企业项目管理API说明> 企业项目管理操作> 查询企业项目绑定的资源列表
更新时间：2022-12-08 GMT+08:00
查看PDF

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

功能介绍

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

URI

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

参数说明请参见表1。
表1 URI格式的参数说明

名称

是否必选

参数类型

说明

enterprise_project_id

是

String

企业项目ID。

可以通过查询企业项目列表接口获取。

请求消息

  • 要素说明
    表2 请求样例的要素说明

    名称

    是否必选

    参数类型

    说明

    limit

    否

    Integer

    查询记录数，不传默认为1000，limit最多为1000，最小值为1。

    offset

    否

    Integer

    索引位置，从offset指定的下一条数据开始查询，必须为数字，不能为负数，默认为0。

    projects

    否

    List<String>

    项目ID列表。请参考获取项目ID章节获取。当传入资源类型为全局资源类型时，此参数可忽略，例如：cdn。当传入的资源类型区分region时，此参数必输，例如ecs，evs等。

    resource_types

    是

    List<String>

    资源类型列表，此参数为可输入的值（区分大小写）。例如：ecs，scaling_group，images，disk，vpcs，security-groups，shared_bandwidth，eip，cdn等。

    详细类型请参考企业项目支持的资源类型。

    matches

    否

    List<match>

    搜索字段，key为要匹配的字段，固定为resource_name，value为匹配的值，不传则表示无匹配条件。

    详细请参见表3。
  • match字段数据结构说明
    表3 match字段数据结构说明

    名称

    是否必选

    参数类型

    说明

    key

    是

    String

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

    value

    是

    String

    值。即资源名称，有matches参数时，该字段为必填，且默认为模糊搜索，如“message.com”。每个值最大长度255个字符。
  • 请求样例
    POST https://{EPS的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"
        }
    ]
}

响应消息

  • 要素说明
    表4 响应样例的要素说明

    名称

    参数类型

    说明

    resources

    List<resource>

    资源列表。

    详情请参见表5。

    errors

    List<error>

    错误列表。

    详情请参见表6。

    total_count

    Integer

    满足查询条件的总记录数。
  • resource字段数据结构说明
    表5 resource字段数据结构说明

    名称

    参数类型

    说明

    project_id

    String

    项目ID。

    project_name

    String

    项目名称。

    resource_type

    String

    资源类型。

    详细类型请参考企业项目支持的资源类型。

    resource_id

    String

    资源ID。

    resource_name

    String

    资源名称。

    resource_detail

    Object

    资源详情。

    enterprise_project_id

    String

    企业项目ID。
  • error字段数据结构说明
    表6 error字段数据结构说明

    名称

    参数类型

    说明

    project_id

    String

    项目ID。

    resource_type

    String

    资源类型。

    详细类型请参考企业项目支持的资源类型。

    error_code

    String

    错误码。

    error_msg

    String

    错误消息。
  • 响应样例
    {
    "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
}

状态码

请参考状态码。

错误码

请参考错误码。