All Products
Search
Document Center

ENS:DescribeSDGs

Last Updated:Apr 09, 2024

Queries information about created shared data groups (SDGs).

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
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"]
InstanceIdsarrayNo

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

Note If you specify the SDGIds and InstanceIds parameters at the same time, the query result is the intersection of the two conditions.
stringNo

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

Note If you specify the SDGIds and InstanceIds parameters at the same time, the query result is the intersection of the two conditions.
["aic-1", "aic-2", "aic-3"]

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

3703C4AC-9396-458C-8F25-1D701334D309
SDGsobject []

The information about the SDGs.

AvaliableRegionIdsobject []

The IDs of available edge nodes.

CreationTimestring

The time when the SDG was created on the node.

2023-02-27 15:13:26
RegionIdstring

The ID of the node.

cn-hangzhou-26
SnapshotIdstring

The ID of the snapshot.

mock-clone_snapshot_id
Statusstring

The status of the SDG on the node. Valid values:

  • sdg_making
  • sdg_saving
  • sdg_copying
  • failed
  • success
success
CreationInstanceIdstring

The ID of the instance on which the SDG is created.

aic-5x20dyeos****
CreationRegionIdstring

The ID of the node on which the SDG is created.

cn-hangzhou-26
CreationTimestring

The time when the SDG was first created.

2023-02-27 15:07:21
DeployedInstanceIdsobject []

The deployment information.

CreationTimestring

The time when the SDG was deployed on the instance.

2023-02-27 16:48:43
InstanceIdstring

The ID of the instance.

aic-5x20dyeos****
Statusstring

The deployment status. Valid values:

  • sdg_deploying
  • failed
  • success
sdg_deploying
DeploymentTypestring

The deployment type of the SDG. Valid values:

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

The description of the SDG.

ParentSDGIdstring

The ID of the source SDG from which you want to create an SDG. The value of this parameter is the value of the FromSDGId parameter that you need to specify when you call the CreateSDG operation.

sdg-xxxxx
SDGIdstring

The ID of the SDG.

sdg-30e1fdba7196bc****
Sizelong

The size of the SDG. Unit: GB.

20
Statusstring

The status of the SDG creation. Valid values:

  • sdg_making
  • sdg_saving
  • failed
  • success
success
UpdateTimestring

The time when the SDG was last updated.

2023-02-27 16:04:39

Examples

Sample success responses

JSONformat

{
  "RequestId": "3703C4AC-9396-458C-8F25-1D701334D309",
  "SDGs": [
    {
      "AvaliableRegionIds": [
        {
          "CreationTime": "2023-02-27 15:13:26",
          "RegionId": "cn-hangzhou-26",
          "SnapshotId": "mock-clone_snapshot_id",
          "Status": "success"
        }
      ],
      "CreationInstanceId": "aic-5x20dyeos****",
      "CreationRegionId": "cn-hangzhou-26",
      "CreationTime": "2023-02-27 15:07:21",
      "DeployedInstanceIds": [
        {
          "CreationTime": "2023-02-27 16:48:43",
          "InstanceId": "aic-5x20dyeos****",
          "Status": "sdg_deploying",
          "DeploymentType": "overlay"
        }
      ],
      "Description": "",
      "ParentSDGId": "sdg-xxxxx",
      "SDGId": "sdg-30e1fdba7196bc****",
      "Size": 20,
      "Status": "success",
      "UpdateTime": "2023-02-27 16:04:39"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400Parameter.InvalidThe parameter is invalid.Please check your parameters and try it again.-
400Interface.Call.ErrorThe interface call error-
400Interface.Call.Failed%s.Request failed
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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