DescribeSDGDeploymentStatus

Updated at: 2025-03-26 03:36

Queries the deployment status of the shared data group (SDG).

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:DescribeSDGDeploymentStatusnone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
SDGIdstringYes

The ID of the SDG.

sdg-xxxx
PageNumberstringNo

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

1
PageSizestringNo

The number of entries returned on each page.

10
DeploymentTypestringNo

The deployment type.

shared
StatusstringNo

The deployment status of the SDG.

success
InstanceIdsarrayNo

IDs of Android in Container (AIC) instances.

stringNo

The ID of the AIC instance.

aic-xxxx
RegionIdsarrayNo

The IDs of the nodes.

stringNo

The ID of the node.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

68B85217-03B8-5141-9216-EA4D7C496B9A
DeploymentStatusarray<object>

The list of SDG deployment information.

DeploymentStatusobject
InstanceIdstring

The ID of the AIC instance.

aic-xxxx
MountTypestring

The deployment type.

Valid values:

  • overlay: read/write splitting.
  • common: common deployment.
overlay
RegionIdstring

The ID of the edge node.

cn-hangzhou
Statusstring

The deployment status of the SDG.

Valid values:

  • sdg_deploying
  • success
  • failed
success
Phasestring

The deployment phase of the SDG.

attach
UpdateTimestring

The time when the status was last updated.

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

The page number. Pages start from page 1. Default value: 1

1
PageSizelong

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

10
TotalCountlong

The total number of queried deployment records.

100

Examples

Sample success responses

JSONformat

{
  "RequestId": "68B85217-03B8-5141-9216-EA4D7C496B9A",
  "DeploymentStatus": [
    {
      "InstanceId": "aic-xxxx",
      "MountType": "overlay",
      "RegionId": "cn-hangzhou",
      "Status": "success",
      "Phase": "attach",
      "UpdateTime": "2023-02-17T02:44:31Z"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 100
}

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.

Change history

Change timeSummary of changesOperation
Change timeSummary of changesOperation
2024-11-26The Error code has changed. The response structure of the API has changedView Change Details
2024-08-13The Error code has changed. The request parameters of the API has changedView Change Details
Previous:NoneNext: ENS
  • On this page (1)
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
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