Domain name for API request: cdb.tencentcloudapi.com.
This API is used to modify the name or description of a placement group.
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: cdb.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: ModifyNameOrDescByDpId. |
| Version | Yes | String | Common parameter. The value used for this API: 2017-03-20. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| DeployGroupId | Yes | String | ID of a placement group. |
| DeployGroupName | No | String | Name of a placement group, which can contain up to 60 characters. The placement group name and description cannot both be empty. |
| Description | No | String | Description of a placement group, which can contain up to 200 characters. The placement group name and description cannot both be empty. |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://cdb.tencentcloudapi.com/?Action=ModifyNameOrDescByDpId
&DeployGroupName=cdb-ezq1vzem&Description=test&DeployGroupId=test
&<Common request parameters>{
"Response": {
"RequestId": "b4a719b5-ffb34ab6-816c43c1-8c6a23eb"
}
}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 |
|---|---|
| InternalError.CdbError | System error. |
| InvalidParameter | Parameter error. |
| InvalidParameter.DeployGroupNotEmpty | There are resources in the placement group. |
| InvalidParameter.OverDeployGroupQuota | The quota of placement group resources has been exceeded. |
| InvalidParameter.ResourceExists | The resource already exists. |
| InvalidParameter.ResourceNotFound | The resource is not found. |
Was this page helpful?