ModifyClusterAttribute

Last updated: 2020-06-24 11:17:36

1. API Description

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

This API is used to modify cluster attributes.

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: ModifyClusterAttribute.
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 Cluster ID
ProjectId No Integer Project of the Cluster
ClusterName No String Cluster name
ClusterDesc No String Cluster description

3. Output Parameters

Parameter Name Type Description
ProjectId Integer Project of the Cluster
Note: this field may return null, indicating that no valid values can be obtained.
ClusterName String Cluster name
Note: this field may return null, indicating that no valid values can be obtained.
ClusterDesc String Cluster description
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 Modifying cluster attributes

Input Example

https://tke.tencentcloudapi.com/?Action=ModifyClusterAttribute
&ClusterId=cls-xxxxxxx
&ClusterName=aaa
&<Common request parameter>

Output Example

{
  "Response": {
    "ClusterName": "xxxxx",
    "ClusterDesc": "xxxxx",
    "ProjectId": 0,
    "RequestId": "eac6b301-a322-493a-8e36-83b295459398"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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 Internal error
InternalError.CamNoAuth You do not have permissions.
InternalError.Db DB error.
InternalError.DbAffectivedRows DB error
InternalError.DbRecordNotFound Record not found.
InternalError.Param Parameter error.
InvalidParameter.Param Invalid parameter.
MissingParameter Parameter is missing
ResourceInUse Resource is in use
ResourceNotFound Resource does not exist
ResourceUnavailable Resource is unavailable

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help