ModifyNameOrDescByDpId

Download PDF

Last updated: 2024-11-20 11:12:58

Last updated: 2024-11-20 11:12:58

Download PDF

1. API Description

Domain name for API request: cdb.intl.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.

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 Params. The value used for this API: ModifyNameOrDescByDpId.
Version	Yes	String	Common Params. The value used for this API: 2017-03-20.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
DeployGroupId	Yes	String	Placement group ID
DeployGroupName	No	String	Name of a placement group, which can contain up to 60 characters. The placement group name and description can’t be empty.
Description	No	String	Description of a placement group, which can contain up to 200 characters. The placement group name and description can’t be empty.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Modifying the name or description of a placement group

Input Example

https://cdb.intl.tencentcloudapi.com/?Action=ModifyNameOrDescByDpId
&DeployGroupName=cdb-ezq1vzem
&Description=test
&DeployGroupId=test
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "b4a719b5-ffb34ab6-816c43c1-8c6a23eb"
    }
}

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

Tencent Cloud CLI 3.0

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.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?

You can also Contact Sales or Submit a Ticket for help.

Yes

tencent cloud