DescribeSDG - - Alibaba Cloud Documentation Center

Queries basic information about shared data groups (SDGs), including node preload information.

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:DescribeSDG	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"]
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page. Default value: 10	10

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	F3B261DD-3858-4D3C-877D-303ADF374600
SDGs	array<object>	The information about the SDGs.
SDGs	object
AvaliableRegionIds	array<object>	SDGs that have snapshots.
AvaliableRegionIds	object
CreationTime	string	The time when the SDG was created on the node.	2023-02-27 15:13:26
RegionId	string	The ID of the node.	cn-hangzhou-26
SnapshotId	string	The ID of the snapshot.	sp-517qu0tgznrg622he7nf4wd7n
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 first SDG in the node was created.	2023-02-27 15:07:21
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
PreloadInfos	array<object>	The preload information.
PreloadInfos	object
RegionId	string	The ID of the node.	cn-hangzhou
Namespace	string	The namespace.	test-20000
RedundantNum	integer	The number of redundant replicas to quickly respond to shared mounts.	2
CreationTime	string	The time when the SDG was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2023-02-16T06:18:40Z
UpdateTime	string	The time when the status was last updated.	2021-01-22T08:17Z
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of returned entries.	49

Examples

Sample success responses

JSONformat

{
  "RequestId": "F3B261DD-3858-4D3C-877D-303ADF374600",
  "SDGs": [
    {
      "AvaliableRegionIds": [
        {
          "CreationTime": "2023-02-27 15:13:26",
          "RegionId": "cn-hangzhou-26",
          "SnapshotId": "sp-517qu0tgznrg622he7nf4wd7n",
          "Status": "success"
        }
      ],
      "CreationInstanceId": "aic-5x20dyeos****",
      "CreationRegionId": "cn-hangzhou-26",
      "CreationTime": "2023-02-27 15:07:21",
      "Description": "Testing SDGs\n",
      "ParentSDGId": "sdg-xxxxx",
      "SDGId": "sdg-30e1fdba7196bc****",
      "Size": 20,
      "Status": "success",
      "UpdateTime": "2023-02-27 16:04:39",
      "PreloadInfos": [
        {
          "RegionId": "cn-hangzhou",
          "Namespace": "test-20000",
          "RedundantNum": 2,
          "CreationTime": "2023-02-16T06:18:40Z",
          "UpdateTime": "2021-01-22T08:17Z"
        }
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 49
}

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.