DescribeInstanceSDGStatus

Updated at: 2025-03-26 03:33

Queries shared data groups (SDGs) that are mounted to an Android in Container (AIC) instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
OperationAccess levelResource typeCondition keyAssociated operation
ens:DescribeInstanceSDGStatuslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the AIC instance.

aic-xxxxx
PageNumberintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries per page.

10
StatusstringNo

The deployment status of the SDG.

success
SDGIdsarrayNo

The IDs of SDGs that you want to query. By default, all SDGs are queried.

stringNo

The IDs of SDGs that you want to query. By default, all SDGs are queried.

["sdg-1", "sdg-2", "sdg-3"]

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object

The response.

RequestIdstring

The request ID.

C0003E8B-B930-4F59-ADC0-0E209A9012A8
DeploymentStatusarray<object>

The deployment information of the SDGs.

DeploymentStatusobject

The deployment information of the SDG.

InstanceIdstring

The ID of the AIC instance.

aic-xxxx
SDGIdstring

The ID of the SDG.

sdg-xxxxxxx
MountTypestring

The deployment type of the SDG.

shared
EnsRegionIdstring

The ID of the edge node.

cn-guangzhou-26
Statusstring

The deployment status of the SDG.

success
Phasestring

Deployment Phase

attach
UpdateTimestring

The time when the status was last updated.

2023-02-17T02:44:31Z
PageNumberlong

The number of the page to return. Pages start from page 1. Default value: 1

1
PageSizestring

The number of entries to return on each page. Default value: 10.

10
TotalCountstring

The total number of queried deployment records.

1

Examples

Sample success responses

JSONformat

{
  "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"
    }
  ],
  "PageNumber": 1,
  "PageSize": "10",
  "TotalCount": "1"
}

Error codes

HTTP status codeError codeError messageDescription
HTTP status codeError codeError messageDescription
400Interface.Call.Failed%s.Request failed
400Interface.Call.ErrorThe interface call error-
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

For a list of error codes, visit the Service error codes.

Previous:NoneNext: ENS
  • On this page (1)
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
Feedback
phone Contact Us

Chat now with Alibaba Cloud Customer Service to assist you in finding the right products and services to meet your needs.

alicare alicarealicarealicare