Use DescribeSDGs to query Shared Data Groups - ENS

Query the information of created shared data groups.

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:DescribeSDGs

none

*All Resource

*

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 elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	3703C4AC-9396-458C-8F25-1D701334D309
SDGs	array<object>	The information about the SDGs.
	array<object>	The information about the SDGs.
AvaliableRegionIds	array<object>	The IDs of available edge nodes.
	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
CreationDiskType	string	The disk type of the master disk used to create the SDG.	standard
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.
	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.	TestSDG
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	integer	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
CreationInstanceId	string	The ID of the instance on which the SDG is created.	aic-5x20dyeos****
BillingType	string	Billing type	Open
PerformanceLevel	integer	The sharing ratio of the SDG.	100
BillingCycle	string	The billing cycle of the shared disk.	Hour

Examples

Success response

JSON format

{
  "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"
        }
      ],
      "CreationDiskType": "standard",
      "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": "TestSDG",
      "ParentSDGId": "sdg-xxxxx",
      "SDGId": "sdg-30e1fdba7196bc****",
      "Size": 20,
      "Status": "success",
      "UpdateTime": "2023-02-27 16:04:39",
      "CreationInstanceId": "aic-5x20dyeos****",
      "BillingType": "Open",
      "PerformanceLevel": 100,
      "BillingCycle": "Hour"
    }
  ]
}

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.