Use ModifyDeploymentSetAttribute to modify the name and description of a deployment set - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:ModifyDeploymentSetAttribute

update

*DeploymentSet

acs:ecs:{#regionId}:{#accountId}:deploymentset/{#DeploymentSetId}

None

Request parameters

Parameter	Type	Required	Description	Example
DeploymentSetId	string	Yes	The ID of the deployment set.	ds-bp1frxuzdg87zh4p****
Description	string	No	The new description of the deployment set. It must be 2 to 256 characters long and cannot start with `http://` or `https://`.	TestDescription
DeploymentSetName	string	No	The new name of the deployment set. The name must be 2 to 128 characters long and can contain letters, digits, Chinese characters, colons (:), underscores (_), periods (.), and hyphens (-).	DeploymentSetTestName
RegionId	string	Yes	The region ID of the deployment set. You can call the DescribeRegions operation to obtain the latest list of Alibaba Cloud regions.	cn-hangzhou
Affinity	integer	No	The affinity level of the deployment set. Instances in the deployment set are distributed based on this affinity level. Valid values: 1 to 10. Default value: 1. Important The affinity setting is available only when the deployment strategy is set to high availability (`Strategy = Availability`).	3

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	The input parameter RegionId that is mandatory for processing this request is not supplied.
400	InvalidDeploymentSetName.Malformed	Specified deployment set name is not valid.	The specified DeploymentSetName parameter is invalid.
400	InvalidDescription.Malformed	The specified parameter Description is not valid.	The resource description is invalid. The description must be 2 to 256 characters in length and cannot start with http:// or https://.
400	InvalidDeploymentSetId.NotFound	The specified DeploymentSetId does not exist.	The specified DeploymentSetId parameter does not exist. Check whether the deployment set ID is correct.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.