调用DescribeSDGs查询已创建的共享数据组信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeSDGs

系统规定参数。取值:DescribeSDGs

SDGIds Array of String ["sdg-1", "sdg-2", "sdg-3"]

指定查询若干SDG,默认查询全部。

InstanceIds Array of String ["aic-1", "aic-2", "aic-3"]

指定查询若干Instance,默认查询全部。

说明 若指定了SDGIds,同时指定了InstanceIds,则查询结果为上述两个条件的交集。

返回数据

名称 类型 示例值 描述
RequestId String 3703C4AC-9396-458C-8F25-1D701334D309

请求ID。

SDGs Array of SDGs

SDG信息列表。

AvaliableRegionIds Array of AvaliableRegionIds

可用节点列表。

CreationTime String 2023-02-27 15:13:26

该节点内SDG的创建时间。

RegionId String cn-hangzhou-26

节点ID。

SnapshotId String mock-clone_snapshot_id

快照ID。

Status String success

该节点SDG的状态,包括:

  • sdg_making:制作中。
  • sdg_saving:保存中。
  • sdg_copying:跨节点同步中。
  • failed:制作失败。
  • success:制作成功。
CreationInstanceId String aic-5x20dyeos****

创建SDG的实例ID。

CreationRegionId String cn-hangzhou-26

创建SDG的节点ID。

CreationTime String 2023-02-27 15:07:21

SDG首次创建时间。

DeployedInstanceIds Array of DeployedInstanceIds

部署状态信息列表

CreationTime String 2023-02-27 16:48:43

SDG在该实例上的部署时间。

InstanceId String aic-5x20dyeos****

实例ID。

Status String sdg_deploying

部署状态,包括:

  • sdg_deploying:部署中。
  • failed:部署失败。
  • success:部署成功。
Description String 测试SDG

SDG的描述信息。

ParentSDGId String sdg-xxxxx

增量制作时,来源SDG的ID,即CreateSDG时传入的FromSDGId

SDGId String sdg-30e1fdba7196bc****

SDG的ID。

Size Long 20

SDG大小,单位GB。

Status String success

SDG制作状态,包括:

  • sdg_making:制作中。
  • sdg_saving:保存中。
  • failed:制作失败。
  • success:制作成功。
UpdateTime String 2023-02-27 16:04:39

SDG最后更新时间。

示例

请求示例

http(s)://ens.aliyuncs.com/?Action=DescribeSDGs
&SDGIds=["[\"sdg-1\", \"sdg-2\", \"sdg-3\"]"]
&InstanceIds=["[\"aic-1\", \"aic-2\", \"aic-3\"]"]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSDGsResponse>
    <RequestId>3703C4AC-9396-458C-8F25-1D701334D309</RequestId>
    <SDGs>
        <AvaliableRegionIds>
            <CreationTime>2023-02-27 15:13:26</CreationTime>
            <RegionId>cn-hangzhou-26</RegionId>
            <SnapshotId>mock-clone_snapshot_id</SnapshotId>
            <Status>success</Status>
        </AvaliableRegionIds>
        <CreationInstanceId>aic-5x20dyeos****</CreationInstanceId>
        <CreationRegionId>cn-hangzhou-26</CreationRegionId>
        <CreationTime>2023-02-27 15:07:21</CreationTime>
        <DeployedInstanceIds>
            <CreationTime>2023-02-27 16:48:43</CreationTime>
            <InstanceId>aic-5x20dyeos****</InstanceId>
            <Status>sdg_deploying</Status>
        </DeployedInstanceIds>
        <Description>测试SDG</Description>
        <ParentSDGId>sdg-xxxxx</ParentSDGId>
        <SDGId>sdg-30e1fdba7196bc****</SDGId>
        <Size>20</Size>
        <Status>success</Status>
        <UpdateTime>2023-02-27 16:04:39</UpdateTime>
    </SDGs>
</DescribeSDGsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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"
    } ],
    "Description" : "测试SDG",
    "ParentSDGId" : "sdg-xxxxx",
    "SDGId" : "sdg-30e1fdba7196bc****",
    "Size" : 20,
    "Status" : "success",
    "UpdateTime" : "2023-02-27 16:04:39"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 NoPermission Permission denied. 没有足够的权限,请联系云账号管理员授予您相应权限。

访问错误中心查看更多错误码。