更新时间:2024-03-14 GMT+08:00

查询资源实例

功能介绍

查询资源实例。

URI

POST /v2/{project_id}/{resource_type}/resource-instances/{action}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目 ID,获取方式请参见获取项目ID

resource_type

String

资源类型,此处请填写functions

action

String

过滤/计数

枚举值:

  • filter

  • count

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

消息体的类型(格式)

表3 请求Body参数

参数

是否必选

参数类型

描述

without_any_tag

Boolean

是否通过标签过滤

limit

String

每页显示条数

offset

String

查询偏移量

action

String

查询指定action

枚举值:

  • count

  • filter

matches

Array of KvItem objects

查询指定键值对

sys_tags

Array of TagItem objects

查询指定系统标签列表

表4 KvItem

参数

是否必选

参数类型

描述

key

String

value

String

表5 TagItem

参数

是否必选

参数类型

描述

key

String

values

Array of strings

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

resources

Array of ListEnterpriseResourceResult objects

企业项目列表

total_count

Long

资源数

表7 ListEnterpriseResourceResult

参数

参数类型

描述

resource_id

String

资源ID

resource_detail

ListEnterpriseResourceDetail object

tags

Array of KvItem objects

标签列表

sys_tags

Array of KvItem objects

系统标签列表

resource_name

String

资源名称

表8 ListEnterpriseResourceDetail

参数

参数类型

描述

detailId

String

函数urn

表9 KvItem

参数

参数类型

描述

key

String

value

String

状态码: 400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 401

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 403

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 404

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 500

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

查询资源实例。

POST https://{Endpoint}/v2/{project_id}/{resource_type}/resource-instances/{action}

{
  "without_any_tag" : true,
  "limit" : 5,
  "matches" : [ {
    "key" : "resource_name",
    "value" : "test_function"
  } ]
}

响应示例

状态码: 200

ok

  • 示例 1

    {
      "resources" : [ {
        "resource_id" : "34e4516e-e324-412b-914e-c4e568c7d813",
        "resource_detail" : {
          "detailId" : "urn:fss:{region-id}:xxxx:function:default:test_xxx:latest"
        },
        "tags" : [ ],
        "sys_tags" : [ {
          "key" : "_sys_enterprise_project_id",
          "value" : "df5edab8-c458-4a4c-b87b-a4d3b0a757ce"
        } ],
        "resource_name" : "test_v2_1"
      } ]
    }
  • 示例 2

    1

状态码

状态码

描述

200

ok

400

Bad Request 请求错误。

401

Unauthorized 鉴权失败。

403

Forbidden 没有操作权限。

404

Not Found 找不到资源。

500

Internal Server Error 服务内部错误。

错误码

请参见错误码