DescribeSDGs - - Alibaba Cloud Documentation Center

Queries information about created 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:DescribeSDGs	none	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
SDGIds	array	No	The IDs of SDGs that you want to query. By default, all SDGs are queried.
	string	No	The IDs of SDGs that you want to query. By default, all SDGs are queried.	["sdg-1", "sdg-2", "sdg-3"]
InstanceIds	array	No	The AIC instance ID to be queried.
	string	No	The IDs of instances that you want to query. By default, all instances are queried. Note If you specify the SDGIds and InstanceIds parameters at the same time, the query result is the intersection of the two conditions.	["aic-1", "aic-2", "aic-3"]

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	3703C4AC-9396-458C-8F25-1D701334D309
SDGs	array<object>	The information about the SDGs.
SDGs	object	The information about the SDGs.
AvaliableRegionIds	array<object>	The IDs of available edge nodes.
AvaliableRegionIds	object	List of available nodes.
CreationTime	string	The time when the SDG was created on the node.	2023-02-27 15:13:26
RegionId	string	The ID of the edge node.	cn-hangzhou-26
SnapshotId	string	The ID of the snapshot.	mock-clone_snapshot_id
Status	string	The status of the SDG on the node. Valid values: sdg_making sdg_saving sdg_copying failed success	success
CreationInstanceId	string	The ID of the instance on which the SDG is created.	aic-5x20dyeos****
CreationRegionId	string	The ID of the node on which the SDG is created.	cn-hangzhou-26
CreationTime	string	The time when the SDG was first created.	2023-02-27 15:07:21
DeployedInstanceIds	array<object>	The deployment information.
DeployedInstanceIds	object	Deployment status information list
CreationTime	string	The time when the SDG was deployed on the instance.	2023-02-27 16:48:43
InstanceId	string	The ID of the instance.	aic-5x20dyeos****
Status	string	The deployment status. Valid values: sdg_deploying failed success	sdg_deploying
DeploymentType	string	The deployment type of the SDG. Valid values: common: common deployment. overlay: read/write splitting deployment.	overlay
Description	string	The description of the SDG.	Testing SDGs
ParentSDGId	string	The ID of the source SDG from which you want to create an SDG. The value of this parameter is the value of the FromSDGId parameter that you need to specify when you call the CreateSDG operation.	sdg-xxxxx
SDGId	string	The ID of the SDG.	sdg-30e1fdba7196bc****
Size	long	The size of the SDG. Unit: GB.	20
Status	string	The status of the SDG creation. Valid values: sdg_making sdg_saving failed success	success
UpdateTime	string	The time when the SDG was last updated.	2023-02-27 16:04:39

Examples

Sample success responses

JSONformat

{
  "RequestId": "3703C4AC-9396-458C-8F25-1D701334D309",
  "SDGs": [
    {
      "AvaliableRegionIds": [
        {
          "CreationTime": "2023-02-27 15:13:26",
          "RegionId": "cn-hangzhou-26",
          "SnapshotId": "mock-clone_snapshot_id",
          "Status": "success"
        }
      ],
      "CreationInstanceId": "aic-5x20dyeos****",
      "CreationRegionId": "cn-hangzhou-26",
      "CreationTime": "2023-02-27 15:07:21",
      "DeployedInstanceIds": [
        {
          "CreationTime": "2023-02-27 16:48:43",
          "InstanceId": "aic-5x20dyeos****",
          "Status": "sdg_deploying",
          "DeploymentType": "overlay"
        }
      ],
      "Description": "Testing SDGs\n",
      "ParentSDGId": "sdg-xxxxx",
      "SDGId": "sdg-30e1fdba7196bc****",
      "Size": 20,
      "Status": "success",
      "UpdateTime": "2023-02-27 16:04:39"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
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-07-02	The Error code has changed. The response structure of the API has changed	View Change Details
2024-06-27	The Error code has changed. The response structure of the API has changed	View Change Details
2024-04-24	The Error code has changed	View Change Details