1. 接口描述
接口请求域名: tke.tencentcloudapi.com 。
修改预留券的抵扣范围,抵扣范围取值:Region、Zone 和 Node。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyReservedInstanceScope。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ReservedInstanceIds.N | 是 | Array of String | 预留券唯一 ID |
ReservedInstanceScope | 是 | ReservedInstanceScope | 预留券抵扣范围信息 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 资源 ID 不存在
输入的资源 ID不存在
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyReservedInstanceScope
<公共请求参数>
{
"ReservedInstanceIds": [
"eksri-762dtf7"
],
"ReservedInstanceScope": {
"Scope": "region"
}
}
输出示例
{
"Response": {
"Error": {
"Code": "ResourceNotFound.NotFound",
"Message": "ReservedInstanceIds:[]string{\"eksri-762dtf7\"} not found"
},
"RequestId": "134fa43d-83a5-4b8d-8ea9-293a96515b68"
}
}
示例2 抵扣范围为地域
设置预留券抵扣范围为地域
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyReservedInstanceScope
<公共请求参数>
{
"ReservedInstanceIds": [
"eksri-762dtf76"
],
"ReservedInstanceScope": {
"Scope": "Region"
}
}
输出示例
{
"Response": {
"RequestId": "9544ca07-e5da-4bde-8c27-807cf018e2f5"
}
}
示例3 Scope 输入错误示例
Scope 输入错误示例
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyReservedInstanceScope
<公共请求参数>
{
"ReservedInstanceIds": [
"eksri-762dtf76"
],
"ReservedInstanceScope": {
"Scope": "regio"
}
}
输出示例
{
"Response": {
"Error": {
"Code": "InternalError.Param",
"Message": "Scope must be in [Region, Zone, Node]"
},
"RequestId": "e88f8640-0e36-4154-a3bf-907b01aa62f0"
}
}
示例4 设置抵扣范围为节点
设置抵扣范围为节点
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyReservedInstanceScope
<公共请求参数>
{
"ReservedInstanceIds": [
"eksri-762dtf76"
],
"ReservedInstanceScope": {
"Scope": "Node",
"Zone": "ap-guangzhou-2",
"ClusterId": "cls-3dkzu9z2",
"NodeName": "eklet-subnet-f0ed0d6e-24k6ucw0"
}
}
输出示例
{
"Response": {
"RequestId": "67a932f4-1823-4cea-a16b-0744828dc597"
}
}
示例5 设置抵扣范围为可用区
抵扣范围为可用区时,Zone 必传,如:ap-guangzhou-2
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyReservedInstanceScope
<公共请求参数>
{
"ReservedInstanceIds": [
"eksri-762dtf76"
],
"ReservedInstanceScope": {
"Scope": "Zone"
}
}
输出示例
{
"Response": {
"Error": {
"Code": "InternalError.Param",
"Message": "Zone invalid"
},
"RequestId": "e949558d-f637-4223-8305-047cb2d5bf06"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.Param | Param。 |
InternalError.UnexpectedInternal | 未知的内部错误。 |
ResourceNotFound.NotFound | 资源未找到。 |