DeploySDG - - Alibaba Cloud Documentation Center

Deploys shared data groups (SDGs).

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ens:DeploySDG		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceIds	array	Yes	The IDs of instances on which you want to deploy SDGs. You can deploy SDGs on a maximum of 100 instances at a time.
	string	Yes	The IDs of instances on which you want to deploy SDGs. You can deploy SDGs on a maximum of 100 instances at a time.	["aic-1", "aic-2", "aic-3"]
SDGId	string	Yes	The SDG ID. This parameter is used to create a disk, which is attached to an instance.	sdg-xxxxx
DeploymentType	string	No	The SDG deployment type. Valid values: common (default): read/write deployment. Data updates are written to disks. overlay: read/write splitting deployment. Content in SDGs is read-only. Data updates are written to the local storage of the instance.	common

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	A331CA96-3948-4BD2-B067-F6174F5C17EA
Data	object	The returned data object.
Message	string	The response message. Success is returned for a successful request.	success
Result	object	The task result.
FailedCount	long	The number of failed tasks.	0
FailedItems	array<object>	Details of failed tasks.
FailedItem	object
ErrMessage	string	The error message.	sdg not found
InstanceId	string	The ID of the instance.	aic-xxxxx-0
SuccessCount	long	The number of successful tasks.	1
Success	boolean	Indicates whether all tasks are successful. Valid values: true: All tasks are successful. false: Failed tasks exist.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "A331CA96-3948-4BD2-B067-F6174F5C17EA",
  "Data": {
    "Message": "success",
    "Result": {
      "FailedCount": 0,
      "FailedItems": [
        {
          "ErrMessage": "sdg not found",
          "InstanceId": "aic-xxxxx-0"
        }
      ],
      "SuccessCount": 1
    },
    "Success": true
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	Interface.Call.Error	The interface call error	-
400	Interface.Call.Failed	%s.	Request failed
400	Parameter.Invalid	The parameter is invalid. Please check your parameters and try it again.	The parameter is invalid.
400	NoPermission	Permission denied.	-
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-03-22	The Error code has changed	View Change Details
2024-02-28	The Error code has changed	View Change Details
2023-11-23	The request parameters of the API has changed	View Change Details