DescribeEnableVpcCniProgress

Last updated: 2021-08-03 10:32:22

1. API Description

Domain name for API request: tke.tencentcloudapi.com.

This API is used to query the task progress of enabling VPC-CNI mode.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: tke.ap-shanghai-fsi.tencentcloudapi.com

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeEnableVpcCniProgress.
Version Yes String Common parameter. The value used for this API: 2018-05-25.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
ClusterId Yes String ID of the cluster for which you want to enable the VPC-CNI mode

3. Output Parameters

Parameter Name Type Description
Status String Task status, which can be Running, Succeed, or Failed.
ErrorMessage String The description for the task status when the task status is “Failed”, for example, failed to install the IPAMD component.
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the task progress of enabling VPC-CNI mode

This API is used to query the process of the async task created when the user calls EnableVpcCniNetworkType to enable VPC-CNI network mode for GR cluster.

Input Example

POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeEnableVpcCniProgress
<Common request parameters>

{
    "ClusterId": "xx"
}

Output Example

{
  "Response": {
    "Status": "xx",
    "ErrorMessage": "xxxx",
    "RequestId": "xx"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError.UnexceptedInternal Internal error.