容器服务
有奖：语音产品征文挑战赛等你来> HOT
文档中心 > 容器服务 > API 文档 > 资源预留券相关接口 > 根据规格查询 Pod 信息

根据规格查询 Pod 信息

最近更新时间：2024-04-03 11:29:58

我的收藏

本页目录：

1. 接口描述

接口请求域名： tke.tencentcloudapi.com 。

查询可以用预留券抵扣的 Pod 信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribePodsBySpec。
Version 是 String 公共参数，本接口取值：2018-05-25。
Region 是 String 公共参数，详见产品支持的 地域列表。
Cpu 是 Float 核数
示例值：1
Memory 是 Float 内存
示例值：2
GpuNum 否 String 卡数，有0.25、0.5、1、2、4等
示例值：0.25
Zone 否 String 可用区
示例值：ap-guangzhou-2
ClusterId 否 String 集群 ID
示例值：cls-12345678
NodeName 否 String 节点名称
示例值：eklet-subnet-0j105iya
Offset 否 Integer 偏移量，默认0。
示例值：0
Limit 否 Integer 返回数量，默认为20，最大值为100。
示例值：20
Filters.N 否 Array of Filter pod-type
按照【Pod 类型】进行过滤。资源类型：intel、amd、v100、t4、a10*gnv4、a10*gnv4v等。
类型：String
必选：否

pod-deduct
按照【上个周期抵扣的Pod】进行过滤。Values可不设置。
必选：否

pod-not-deduct
按照【上个周期未抵扣的Pod】进行过滤。Values可不设置。
必选：否

3. 输出参数

参数名称 类型 描述
TotalCount Integer Pod 总数
示例值：0
PodSet Array of PodNodeInfo Pod 节点信息
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 Filter Name值不支持

Filter Name只支持文档中的示例值

输入示例

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

{
    "Cpu": 1,
    "Memory": 2,
    "Filters": [
        {
            "Name": "not-support-filter-name"
        }
    ]
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "InternalError.Param",
            "Message": "Filter Name:not-support-filter-name not supported"
        },
        "RequestId": "3323e599-cc1f-481b-95a7-dec3f145d158"
    }
}

示例2 查询满足规格的 Pod 信息

可被预留券抵扣的 Pod 信息

输入示例

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

{
    "Cpu": 1,
    "Memory": 2
}

输出示例

{
    "Response": {
        "PodSet": [],
        "RequestId": "3bd23fef-56bf-4d61-a2f2-5ea6adef1508",
        "TotalCount": 0
    }
}

示例3 不传 Filter 时默认查 intel 类型的 Pod 列表

可通过 Filter中的 pod-type 指定查询某些类型的 Pod

输入示例

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

{
    "Cpu": 1,
    "Memory": 2
}

输出示例

{
    "Response": {
        "PodSet": [
            {
                "ClusterId": "cls-3dkzu9z2",
                "Name": "nginx-6456b5b94c-8z5c5",
                "Namespace": "default",
                "NodeName": "eklet-subnet-f0ed0d6e-24k6ucw0",
                "Zone": "ap-guangzhou-2"
            }
        ],
        "RequestId": "3ee798bf-2e16-437a-8248-b00bf8113729",
        "TotalCount": 1
    }
}

示例4 查询指定规格类型为 intel 的所有 pod 列表

查询指定规格类型为 intel 的所有 pod 列表

输入示例

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

{
    "Cpu": 1,
    "Memory": 2,
    "Filters": [
        {
            "Name": "pod-type",
            "Values": [
                "intel"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "PodSet": [
            {
                "ClusterId": "cls-3dkzu9z2",
                "Name": "nginx-6456b5b94c-8z5c5",
                "Namespace": "default",
                "NodeName": "eklet-subnet-f0ed0d6e-24k6ucw0",
                "Zone": "ap-guangzhou-2"
            }
        ],
        "RequestId": "850b62dd-7f50-49f5-97df-1a960d3d6360",
        "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. 错误码

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

错误码 描述
InternalError.Param Param。
InternalError.UnexpectedInternal 未知的内部错误。
中国站