All Products
Search
Document Center

ENS:DescribeSDGDeploymentStatus

Last Updated:Jul 26, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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
ens:DescribeSDGDeploymentStatusnone
  • All Resources
    *
    none
none

Request parameters

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 per page.

10

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

The deployment information of the SDG.

object
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 shared data group SDG.

Valid values:

  • sdg_deploying
  • success
  • failed
success
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",
      "UpdateTime": "2023-02-17T02:44:31Z"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 100
}

Error codes

HTTP status codeError codeError message
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
No change history