获取资源列表

最近更新时间:2024-12-06 01:14:07

我的收藏

1. 接口描述

接口请求域名: config.tencentcloudapi.com 。

获取资源列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ListDiscoveredResources。
Version String 公共参数,本接口取值:2022-08-02。
Region String 公共参数,详见产品支持的 地域列表
MaxResults Integer 每页显示数量
示例值:10
Filters.N Array of Filter resourceName:资源名 resourceId :资源ID
示例值:[]
Tags.N Array of Tag 标签
示例值:[ { "tagKey": "运营部门", "tagValue": "开发部 } ]
NextToken String 下一页token
示例值:C3IptlTj6hTlW0WKVO3NI
OrderType String 排序方式 asc、desc
示例值:desc

3. 输出参数

参数名称 类型 描述
Items Array of ResourceListInfo 详情
示例值:{"ResourceType":"cvm"}
NextToken String 下一页
注意:此字段可能返回 null,表示取不到有效值。
示例值:C3IptlTj6hTlW0WKVO3NI
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取资源列表

输入示例

POST / HTTP/1.1
Host: config.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListDiscoveredResources
<公共请求参数>

{
    "OrderType": "desc",
    "NextToken": "C3IptlTj6hTlW0WKVO3NI",
    "MaxResults": 10,
    "Filters": [
        {
            "Values": [
                "ins-234234"
            ],
            "Name": "resourceName"
        }
    ],
    "Tags": [
        {
            "TagKey": "开发部",
            "TagValue": "运营部"
        }
    ]
}

输出示例

{
    "Response": {
        "Items": [
            {
                "ResourceStatus": "Running",
                "Tags": [
                    {
                        "TagKey": "开发部",
                        "TagValue": "运营部"
                    }
                ],
                "ResourceType": "cvm",
                "ResourceId": "ins-234er",
                "ResourceCreateTime": "2022-10-10 12:56:37",
                "ResourceRegion": "ap-guangzhou",
                "ResourceName": "云服务器",
                "ResourceZone": "ap-guangzhou-1",
                "ResourceDelete": 1,
                "ComplianceResult": "COMPLIANT"
            }
        ],
        "NextToken": "C3IptlTj6hTlW0WKVO3NI",
        "RequestId": "4006b9ea-9b33-4b80-8496-6917c900b122"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InvalidParameter 参数错误。