Call the ModifyDeploymentSetAttribute operation to modify the name and description of a deployment set.

Request description

When you call this operation, if you do not pass in optional parameters, the original configuration is retained.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Only the request parameters specific to this operation and some common parameters are listed below. For more information, please refer to Common parameters.

Action string required Sample value: ModifyDeploymentSetAttribute

The action that you want to perform. Value: ModifyDeploymentSetAttribute.

Version string required Sample value: 2020-04-01

The version of the API. Valid value: 2020-04-01.

ClientToken string Optional Sample value: 333456899ff****

The ClientToken is used to ensure the request idempotency. The client can automatically generate a token, but you need to ensure that it is unique across requests. This prevents duplicate operations caused by multiple retries when the API request times out or an internal server error occurs.

Value: Only ASCII characters are supported. The length is no more than 64 ASCII characters.

DeploymentSetId string required Sample value: dps-yc1o9aahks5m57nk****

The ID of the deployment set.

You can call DescribeDeploymentSets to query deployment set IDs.

DeploymentSetName string Optional Sample value: testDeploymentSet

The name of the deployment set.

Cannot start with a number, a hyphen (-), or an underscore (_).

Only Chinese characters, letters, numbers, underscores, and hyphens are allowed.

The length limit is 1 to 128 characters.

Description string Optional Sample value: testDescription

The description of the deployment set.

Start with a letter or Chinese character only.

Only Chinese characters, letters, numbers, dots (.), spaces, underscores (_), hyphen (-), equal signs (=), English comma (,), Chinese comma (，), and Chinese period (。) are allowed.

The length is limited to 255 characters.

tip

When an empty string is passed in, the existing description is cleared.

Response parameters

This operation has no specific response parameters. For more information, refer to Response structure.

Sample request

Sample response

Error codes

The table below lists the business-related error codes of the operation. For more information, refer to Common error codes.

Status code	Error code	Error message	Description
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.	The idempotent parameters are inconsistent.
400	InvalidClientToken.Malformed	The specified ClientToken is malformed.	The specified ClientToken is invalid.
400	InvalidDeploymentSetDescription.Malformed	The specified deployment set description is malformed.	The specified deployment set description is invalid.
400	InvalidDeploymentSetName.Malformed	The specified DeploymentSetName is malformed.	The specified deployment set name is invalid.
400	MissingParameter.DeploymentSetId	The required parameter DeploymentSetId is not supplied.	The deployment set ID cannot be empty.
404	InvalidDeploymentSet.NotFound	The specified DeploymentSet does not exist.	The specified deployment set does not exist.
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	The previous idempotent request is still in process. Please try again later.
500	InternalError	An internal error has occurred.	An internal error occurred. Try again. If multiple attempts fail, submit a ticket.

Elastic Compute Service