DescribeSDGSharedDisks API Overview - ENS

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

none

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
SdgId	string	Yes	The ID of the SDG.	sdg-xxxx
RegionId	string	No	The ID of the region.	cn-hangzhou-xx
Namespace	string	No	The namespace.	default
PageNumber	integer	No	The page number for a paged query.	1
PageSize	integer	No	The number of entries to return on each page.	10

Response elements

Element	Type	Description	Example
	object	Response schema
RequestId	string	The unique ID of the request.	xxxsxxxxx
SharedDisks	array<object>	The list of shared disks.
	object	The first disk in the list of shared disks.
SdgId	string	The ID of the SDG.	sdg-fqehhfdjv
RegionId	string	The ID of the region.	cn-hangzhou-1
Namespace	string	The namespace.	default
DiskId	string	The ID of the shared disk.	d-57kvvpuj1rk2ghumlgs6
SharedNum	integer	The number of times the disk is mounted.	10
Status	string	The status of the shared disk.	avaliable
DiskType	string	The type of the shared disk.	standard
CreationTime	string	The time when the shared disk was created.	2025-10-09T15:13:21+08:00
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned on each page.	10
TotalCount	integer	The total number of entries.	10

Examples

Success response

JSON format

{
  "RequestId": "xxxsxxxxx",
  "SharedDisks": [
    {
      "SdgId": "sdg-fqehhfdjv",
      "RegionId": "cn-hangzhou-1",
      "Namespace": "default",
      "DiskId": "d-57kvvpuj1rk2ghumlgs6",
      "SharedNum": 10,
      "Status": "avaliable",
      "DiskType": "standard",
      "CreationTime": "2025-10-09T15:13:21+08:00"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 10
}

Error codes

HTTP status code	Error code	Error message	Description
400	Interface.Call.Failed	%s.	Request failed
400	Interface.Call.Error	The interface call error
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.