DescribeSDG API Overview for ENS Shared Data Groups - ENS - Alibaba Cloud - ENS

Retrieves the basic information for a Shared Data Group (SDG), including its 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	The IDs of the SDGs. If omitted, all SDGs are queried.
	string	No	The SDG ID.	["sdg-1", "sdg-2", "sdg-3"]
PageNumber	integer	No	The page number to return.	1
PageSize	integer	No	The page size. Default value: 10.	10
SameDiskId	boolean	No

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	F3B261DD-3858-4D3C-877D-303ADF374600
SDGs	array<object>	A list of SDGs.
	array<object>
AvaliableRegionIds	array<object>	The nodes where snapshots of the SDG are available.
	object
CreationTime	string	The time when the SDG was created on the node.	2023-02-27 15:13:26
RegionId	string	The node ID.	cn-hangzhou-26
SnapshotId	string	The snapshot ID.	sp-517qu0tgznrg622he7nf4wd7n
Status	string	The status of the SDG on the node. Valid values: sdg_making: Creating sdg_saving: Saving sdg_copying: Synchronizing across nodes failed: Failed success: Succeeded	success
CreationInstanceId	string	The ID of the instance from which the SDG was created.	aic-5x20dyeos****
CreationDiskType	string	The disk type of the source disk from which the SDG was created.	standard
CreationTime	string	The time when the SDG was first created.	2023-02-27 15:07:21
Description	string	The description of the SDG.	Test SDG
ParentSDGId	string	The ID of the source SDG for incremental creation. This is the value of the FromSDGId that you pass when you call the CreateSDG operation.	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: Failed success: Succeeded	success
PerformanceLevel	string	The sharing ratio of the SDG.	100
UpdateTime	string	The time when the SDG was last updated.	2023-02-27 16:04:39
PreloadInfos	array<object>	The preloading configuration.
	object
RegionId	string	The node ID.	cn-hangzhou
Namespace	string	The namespace.	test-20000
RedundantNum	integer	The number of redundant copies for faster responses from shared mounts.	2
DiskType	string	The disk type of the redundant shared disks.	standard
CreationTime	string	The time when the entry was created, displayed in UTC and in the ISO 8601 format: `yyyy-MM-ddTHH:mm:ssZ`.	2023-02-16T06:18:40Z
UpdateTime	string	The time when the status of the preload entry was last updated.	2021-01-22T08:17Z
CreationRegionId	string	The ID of the node where the SDG was created.	cn-hangzhou-26
BillingType	string	The billing type.	Open
BillingCycle	string	The billing cycle of the shared disk.	Day
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries returned on each page.	10
TotalCount	integer	The total number of entries that match the query.	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": "Test SDG",
      "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.