DescribeSDGDeploymentStatus - - Alibaba Cloud Documentation Center

Queries the deployment status of the shared data group (SDG).

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:DescribeSDGDeploymentStatus	none	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
SDGId	string	Yes	The ID of the SDG.	sdg-xxxx
PageNumber	string	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	string	No	The number of entries per page.	10

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	68B85217-03B8-5141-9216-EA4D7C496B9A
DeploymentStatus	array<object>	The deployment information of the SDG.
DeploymentStatus	object
InstanceId	string	The ID of the AIC instance.	aic-xxxx
MountType	string	The deployment type. Valid values: overlay: read/write splitting. common: common deployment.	overlay
RegionId	string	The ID of the edge node.	cn-hangzhou
Status	string	the deployment status of the shared data group SDG. Valid values: sdg_deploying success failed	success
UpdateTime	string	The time when the status was last updated.	2023-02-17T02:44:31Z
PageNumber	long	The page number. Pages start from page 1. Default value: 1	1
PageSize	long	The number of entries to return on each page. Default value: 10.	10
TotalCount	long	The total number of queried deployment records.	100

Examples

Sample success responses

JSONformat

{
  "RequestId": "68B85217-03B8-5141-9216-EA4D7C496B9A",
  "DeploymentStatus": [
    {
      "InstanceId": "aic-xxxx",
      "MountType": "overlay",
      "RegionId": "cn-hangzhou",
      "Status": "success",
      "UpdateTime": "2023-02-17T02:44:31Z"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 100
}

Error codes

HTTP status code	Error code	Error message	Description
400	Interface.Call.Failed	%s.	Request failed
400	Interface.Call.Error	The interface call error	-
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-11-26	The Error code has changed. The response structure of the API has changed	View Change Details
2024-08-13	The Error code has changed. The request parameters of the API has changed	View Change Details