DescribeResourcesByGroup

1. 接口描述

调用本接口用于查询某个资源组下资源的信息。该接口是分页接口。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称

必选

类型

描述

pageNum

否

Integer

页码。默认值为1。

pageSize

否

Integer

每页的数量。默认值为20。

resourceGroupId

是

String

资源组唯一标识UID。

resourceType

否

String

资源类型。DescribeResourceTypes返回集的元素。

updateTimeSort

否

String

更新时间排序方式：ascend（正序），descend（倒序）。默认倒序

3. 响应结果

参数名称

类型

描述

requestId

String

唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 requestId。

pageNum

Integer

页码。

pageSize

Integer

每页的数量。

total

Integer

返回总数。

list

Array of ResourceInfo

结果集。

4. 代码示例

分页查询资源组下资源列表

POST /api/v2/user HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeResourcesByGroup
<Common Request Params>

Request:
{
    "pageNum":1,
    "pageSize":20,
    "resourceGroupId":"c91db3f4-b15e-4323-9a12-fd3f0330b74b",
    "resourceType":"ZGA_ACCELERATOR",
    "updateTimeSort":null
}

Response:
{
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "response": {
        "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
        "pageNum": 1,
        "pageSize": 20,
        "total": 2,
        "list": [
            {
                "resourceId":"1069322610690759681",
                "name":"www.uu.test_United States",
                "aliasName":"www.uu.test_United States",
                "resourceType":"ZGA_ACCELERATOR",
                "createTime":"2024-01-15T09:13:09Z",
                "updateTime":"2024-01-15T09:13:09Z"
            },
            {
                "resourceId":"1010516689890323201",
                "name":"www.testzga.com_United States",
                "aliasName":"www.testzga.com_United States",
                "resourceType":"ZGA_ACCELERATOR",
                "createTime":"2023-10-26T05:56:17Z",
                "updateTime":"2023-10-26T05:56:17Z"
            }
        ]
    }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码

错误码

说明

404

INVALID_RESOURCE_GROUP_ID

指定的资源组不存在。

最后更新于10个月前