API 中心

文档中心 API 中心容器服务资源预留券相关接口查询预留实例列表

查询预留实例列表

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

我的收藏

本页目录：

1. 接口描述

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

查询预留实例列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeReservedInstances。
Version	是	String	公共参数，本接口取值：2018-05-25。
Region	是	String	公共参数，详见产品支持的地域列表。
Offset	否	Integer	偏移量，默认0。示例值：0
Limit	否	Integer	返回数量，默认为20，最大值为100。示例值：20
Filters.N	否	Array of Filter	status 按照【状态】进行过滤。状态：Creating、Active、Expired、Refunded。类型：String 必选：否 resource-type 按照【资源类型】进行过滤。资源类型：common、amd、v100、t4、a10gnv4、a10gnv4v等，common表示通用类型。类型：String 必选：否 cpu 按照【核数】进行过滤。类型：String 必选：否 memory 按照【内存】进行过滤。类型：String 必选：否 gpu 按照【GPU卡数】进行过滤，取值有0.25、0.5、1、2、4等。类型：String 必选：否 cluster-id 按照【集群ID】进行过滤。类型：String 必选：否 node-name 按照【节点名称】进行过滤。类型：String 必选：否 scope 按照【可用区】进行过滤。比如：ap-guangzhou-2，为空字符串表示地域抵扣范围。如果只过滤可用区抵扣范围，需要同时将cluster-id、node-name设置为空字符串。类型：String 必选：否 reserved-instance-id 按照【预留实例ID】进行过滤。预留实例ID形如：eksri-xxxxxxxx。类型：String 必选：否 reserved-instance-name 按照【预留实例名称】进行过滤。类型：String 必选：否 reserved-instance-deduct 按照【上个周期抵扣的预留券】进行过滤。Values可不设置。必选：否 reserved-instance-not-deduct 按照【上个周期未抵扣的预留券】进行过滤。Values可不设置。必选：否
OrderField	否	String	排序字段。支持CreatedAt、ActiveAt、ExpireAt。默认值CreatedAt。示例值：CreatedAt
OrderDirection	否	String	排序方法。顺序：ASC，倒序：DESC。默认值DESC。示例值：DESC

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	总数。示例值：0
ReservedInstanceSet	Array of ReservedInstance	预留实例列表。
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: DescribeReservedInstances
<公共请求参数>

{
    "Filters": [
        {
            "Name": "not-support-filter-name",
            "Values": [
                "value"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "InternalError.Param",
            "Message": "Filter Name:not-support-filter-name not supported"
        },
        "RequestId": "b31166bd-80d6-4868-b13a-952bc1cdc74c"
    }
}

示例2 DescribeReservedInstances

查询预留券列表

输入示例

https://tke.tencentcloudapi.com/?Action=DescribeReservedInstances
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 0,
        "ReservedInstanceSet": [],
        "RequestId": "a1be36f0-1aa4-4af2-a289-da021bcef89f"
    }
}

示例3 支持的 Filter Name示例

支持的 Filter Name示例

输入示例

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

{
    "Filters": [
        {
            "Name": "status",
            "Values": [
                "Active"
            ]
        },
        {
            "Name": "scope",
            "Values": [
                "ap-guangzhou-2"
            ]
        },
        {
            "Name": "cluster-id",
            "Values": [
                "cls-3dkzu9z2"
            ]
        },
        {
            "Name": "node-name",
            "Values": [
                "eklet-subnet-9hxmgam6-790879"
            ]
        },
        {
            "Name": "cpu",
            "Values": [
                "2"
            ]
        },
        {
            "Name": "memory",
            "Values": [
                "4"
            ]
        },
        {
            "Name": "resource-type",
            "Values": [
                "common"
            ]
        },
        {
            "Name": "gpu",
            "Values": [
                ""
            ]
        },
        {
            "Name": "reserved-instance-id",
            "Values": [
                "eksri-f9rwc82i"
            ]
        },
        {
            "Name": "reserved-instance-name",
            "Values": [
                "c"
            ]
        },
        {
            "Name": "reserved-instance-not-deduct"
        }
    ],
    "OrderField": "ExpireAt",
    "OrderDirection": "ASC"
}

输出示例

{
    "Response": {
        "TotalCount": 0,
        "ReservedInstanceSet": [],
        "RequestId": "a1be36f0-1aa4-4af2-a289-da021bcef89f"
    }
}

示例4 查询可用区范围的预留券

只查询可用区抵扣的需要设置cluster-id和node-name 为空字符串

输入示例

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

{
    "Filters": [
        {
            "Name": "status",
            "Values": [
                "Active"
            ]
        },
        {
            "Name": "scope",
            "Values": [
                "ap-guangzhou-2"
            ]
        },
        {
            "Name": "cluster-id",
            "Values": [
                ""
            ]
        },
        {
            "Name": "node-name",
            "Values": [
                ""
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "e49fe7f4-16f3-4640-839d-514edd3e897a",
        "ReservedInstanceSet": [],
        "TotalCount": 0
    }
}

示例5 查询地域抵扣范围预留券

查询地域抵扣范围预留券

输入示例

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

{
    "Filters": [
        {
            "Name": "status",
            "Values": [
                "Active"
            ]
        },
        {
            "Name": "scope",
            "Values": [
                ""
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 0,
        "ReservedInstanceSet": [],
        "RequestId": "a1be36f0-1aa4-4af2-a289-da021bcef89f"
    }
}

示例6 查询节点抵扣范围的预留券

查询节点抵扣范围的预留券

输入示例

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

{
    "Filters": [
        {
            "Name": "status",
            "Values": [
                "Active"
            ]
        },
        {
            "Name": "scope",
            "Values": [
                "ap-guangzhou-2"
            ]
        },
        {
            "Name": "cluster-id",
            "Values": [
                "cls-3dkzu9z2"
            ]
        },
        {
            "Name": "node-name",
            "Values": [
                "eklet-subnet-9hxmgam6-790879"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "TotalCount": 0,
        "ReservedInstanceSet": [],
        "RequestId": "a1be36f0-1aa4-4af2-a289-da021bcef89f"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。
InternalError.Param	Param。
InternalError.UnexceptedInternal	内部错误。
InternalError.UnexpectedInternal	未知的内部错误。
InvalidParameter	参数错误。
InvalidParameter.Param	参数错误。

上一篇: 查询按量计费超级节点上的资源详情下一篇: 购买预留券实例