DescribeSDG API Overview for ENS Shared Data Groups - ENS

Queries the basic information about a Shared Data Group (SDG), including node preloading details.

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

ens:DescribeSDG

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SDGIds	array	No	Specify the SDGs to query. By default, all SDGs are queried.
	string	No	Specify the SDGs to query. By default, all SDGs are queried.	["sdg-1", "sdg-2", "sdg-3"]
PageNumber	integer	No	The page number for paged queries.	1
PageSize	integer	No	The number of entries per page in paged queries. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	F3B261DD-3858-4D3C-877D-303ADF374600
SDGs	array<object>	The list of SDG information.
	array<object>
AvaliableRegionIds	array<object>	The list of regions where snapshots of the SDG exist.
	object
CreationTime	string	The time when the SDG was created on the node.	2023-02-27 15:13:26
RegionId	string	The region ID.	cn-hangzhou-26
SnapshotId	string	The snapshot ID.	sp-517qu0tgznrg622he7nf4wd7n
Status	string	The status of the SDG in this region. Valid values: sdg_making: Creating. sdg_saving: Saving. sdg_copying: Synchronizing across regions. failed: Creation failed. success: Created successfully.	success
CreationInstanceId	string	The instance ID used to create the SDG.	aic-5x20dyeos****
CreationDiskType	string	The disk type of the source disk used to create the SDG.	standard
CreationTime	string	The initial creation time of the SDG.	2023-02-27 15:07:21
Description	string	The description of the SDG.	TestSDG
ParentSDGId	string	The ID of the source SDG when creating an incremental SDG. This corresponds to the FromSDGId parameter passed in CreateSDG.	sdg-xxxxx
SDGId	string	The ID of the SDG.	sdg-30e1fdba7196bc****
Size	integer	The size of the SDG, in GB.	20
Status	string	The creation status of the SDG. Valid values: sdg_making: Creating. sdg_saving: Saving. failed: Creation failed. success: Created successfully.	success
PerformanceLevel	string	The sharing ratio of the SDG.	100
UpdateTime	string	The last update time of the SDG.	2023-02-27 16:04:39
PreloadInfos	array<object>	The preloading configuration information.
	object
RegionId	string	The ID of the node.	cn-hangzhou
Namespace	string	The namespace.	test-20000
RedundantNum	integer	The number of redundant copies to enable fast response for shared mounts.	2
DiskType	string	The disk type of the redundant shared disks.	standard
CreationTime	string	The creation time. The time follows the ISO8601 standard in UTC format: yyyy-MM-ddTHH:mm:ssZ.	2023-02-16T06:18:40Z
UpdateTime	string	The latest status update time.	2021-01-22T08:17Z
CreationRegionId	string	The region ID where the SDG was created.	cn-hangzhou-26
BillingType	string	The billing type.	Open
BillingCycle	string	The billing cycle for the shared disk.	Day
PageNumber	integer	The current page number.	1
PageSize	integer	The number of entries per page in the current query.	10
TotalCount	integer	The total number of entries.	49

Examples

Success response

JSON format

{
  "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****",
      "CreationDiskType": "standard",
      "CreationTime": "2023-02-27 15:07:21",
      "Description": "TestSDG",
      "ParentSDGId": "sdg-xxxxx",
      "SDGId": "sdg-30e1fdba7196bc****",
      "Size": 20,
      "Status": "success",
      "PerformanceLevel": "100",
      "UpdateTime": "2023-02-27 16:04:39",
      "PreloadInfos": [
        {
          "RegionId": "cn-hangzhou",
          "Namespace": "test-20000",
          "RedundantNum": 2,
          "DiskType": "standard",
          "CreationTime": "2023-02-16T06:18:40Z",
          "UpdateTime": "2021-01-22T08:17Z"
        }
      ],
      "CreationRegionId": "cn-hangzhou-26",
      "BillingType": "Open",
      "BillingCycle": "Day"
    }
  ],
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.