Domain name for API request: cvm.tencentcloudapi.com.
This API is used to modify the attributes of a CDH instance, such as instance name and renewal flag. One of the two parameters, HostName and RenewFlag, must be set, but you cannot set both of them at the same time.
A maximum of 10 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: cvm.ap-shanghai-fsi.tencentcloudapi.com
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: ModifyHostsAttribute. |
| Version | Yes | String | Common parameter. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| HostIds.N | Yes | Array of String | CDH instance ID(s). |
| HostName | No | String | CDH instance name to be displayed. You can specify any name you like, but its length cannot exceed 60 characters. |
| RenewFlag | No | String | Auto renewal flag. Valid values: If this parameter is specified as NOTIFY_AND_AUTO_RENEW, the instance will be automatically renewed on a monthly basis if the account balance is sufficient. |
| ProjectId | No | Integer | Project ID. You can create a project by using the AddProject API and obtain its ID from the response parameter projectId of the DescribeProject API. Subsequently, the project ID can be used to filter results when you query instances by calling the DescribeHosts API. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to modify the HostName attribute of a specified CDH instance.
GET https://cvm.tencentcloudapi.com/?Action=ModifyHostsAttribute
&HostIds.0=host-ey16rkyg
&HostName=webserver
&<Common request parameters>
{
"Response": {}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidHost.NotSupported | The specified operation on this CDH instance is not support . |
| InvalidHostId.Malformed | Invalid CDH ID. The specified CDH ID has an invalid format. For example, host-1122 has an invalid ID length. |
| InvalidHostId.NotFound | The specified HostId does not exist, or does not belong to your account. |
Was this page helpful?