DescribeInstanceSDGStatus API Reference for ENS AIC - ENS

Query the SDG mount status under a specific AIC instance.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the AIC instance.	aic-xxxxx
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries returned on each page.	10
Status	string	No	The deployment status of the SDG.	success
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"]

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	C0003E8B-B930-4F59-ADC0-0E209A9012A8
DeploymentStatus	array<object>	The deployment information of the SDGs.
	object	The deployment information of the SDG.
InstanceId	string	The ID of the AIC instance.	aic-xxxx
SDGId	string	The ID of the SDG.	sdg-xxxxxxx
MountType	string	The deployment type of the SDG.	shared
EnsRegionId	string	The ID of the edge node.	cn-guangzhou-26
Status	string	The deployment status of the SDG.	success
Phase	string	Deployment Phase	attach
UpdateTime	string	The time when the status was last updated.	2023-02-17T02:44:31Z
BlockRwSplitSize	integer	The size of the writable layer for block devices, in GiB. A value of 0 indicates that the capability is not enabled.	20
CacheSize	integer	Cache size in GiB. A value of 0 indicates that the capability is not Enabled.	20
DiskType	string	Disk type of the mounted shared disk.	standard
DiskAccessProtocol	string	The protocol type for accessing the mounted shared disk.	iscsi
PageNumber	integer	The number of the page to return. Pages start from page 1. Default value: 1	1
PageSize	string	The number of entries to return on each page. Default value: 10.	10
TotalCount	string	The total number of queried deployment records.	1

Examples

Success response

JSON format

{
  "RequestId": "C0003E8B-B930-4F59-ADC0-0E209A9012A8",
  "DeploymentStatus": [
    {
      "InstanceId": "aic-xxxx",
      "SDGId": "sdg-xxxxxxx",
      "MountType": "shared",
      "EnsRegionId": "cn-guangzhou-26",
      "Status": "success",
      "Phase": "attach",
      "UpdateTime": "2023-02-17T02:44:31Z",
      "BlockRwSplitSize": 20,
      "CacheSize": 20,
      "DiskType": "standard",
      "DiskAccessProtocol": "iscsi"
    }
  ],
  "PageNumber": 1,
  "PageSize": "10",
  "TotalCount": "1"
}

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.