文档中心>容器服务>API 文档>网络相关接口>查询开启vpc-cni异步任务的进度

查询开启vpc-cni异步任务的进度

最近更新时间:2024-03-12 01:57:10

我的收藏

1. 接口描述

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

本接口用于查询开启vpc-cni模式的任务进度

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeEnableVpcCniProgress。
Version String 公共参数,本接口取值:2018-05-25。
Region String 公共参数,详见产品支持的 地域列表
ClusterId String 开启vpc-cni的集群ID
示例值:"cls-xxx"

3. 输出参数

参数名称 类型 描述
Status String 任务进度的描述:Running/Succeed/Failed
示例值:"Running"
ErrorMessage String 当任务进度为Failed时,对任务状态的进一步描述,例如IPAMD组件安装失败
注意:此字段可能返回 null,表示取不到有效值。
示例值:"ipamd has not been installed yet"
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查看开启vpc-cni的任务进度,查询到任务失败

用户调用EnableVpcCniNetworkType给GR集群附加vpc-cni网络能力,会创建一个异步任务。本接口用于查询该异步任务的进度,查询到任务进度失败。

输入示例

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

{
    "ClusterId": "cls-abcdefgh"
}

输出示例

{
    "Response": {
        "Status": "Failed",
        "ErrorMessage": "ipamd has not been installed yet",
        "RequestId": "defc0237-d413-4079-9faa-7f3ff928d224"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.EnableVPCCNIFailed 开启 VPC-CNI 模式失败。
InternalError.UnexceptedInternal 内部错误。
InternalError.UnexpectedInternal 未知的内部错误。