描述系统资源接口

最近更新时间:2024-03-12 01:42:34

我的收藏

1. 接口描述

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

描述系统资源接口

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSystemResources。
Version String 公共参数,本接口取值:2019-04-22。
Region String 公共参数,详见产品支持的 地域列表
ResourceIds.N Array of String 需要查询的资源ID数组
示例值:[]
Offset Integer 偏移量,仅当设置 Limit 参数时有效
示例值:0
Limit Integer 条数限制,默认返回 20 条
示例值:20
Filters.N Array of Filter 查询资源配置列表, 如果不填写,返回该 ResourceIds.N 下所有作业配置列表
示例值:[]
ClusterId String 集群ID
示例值:cluster-xxxx
FlinkVersion String 查询对应Flink版本的内置connector
示例值:Flink-1.11

3. 输出参数

参数名称 类型 描述
ResourceSet Array of SystemResourceItem 资源详细信息集合
示例值:[]
TotalCount Integer 总数量
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询系统资源配置列表示例

输入示例

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

{
    "ClusterId": "cluster-n8yaia0p"
}

输出示例

{
    "Response": {
        "RequestId": "09250e9b-d3a1-4d37-b44f-de10e06ed52d",
        "ResourceSet": [
            {
                "ResourceId": "resource-abd503yt",
                "Name": "testjar",
                "ResourceType": 1,
                "Remark": "",
                "Region": "ap-guangzhou",
                "LatestResourceConfigVersion": 1
            }
        ],
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation 未授权操作。
InternalError 内部错误。
InternalError.DB 数据库异常。
InternalError.FailedToBescribeResources 失败的目标资源。
InvalidParameterValue 参数取值错误。
ResourceNotFound 资源不存在。
ResourceNotFound.ClusterId 集群不存在。
ResourceUnavailable.FailedToBescribeResources 失败的目标资源。