文档

DescribeSDGs - 查询SDG信息

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ens:DescribeSDGsWrite
  • acs:ens::{#accountId}:*

请求参数

名称类型必填描述示例值
SDGIdsarray

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

string

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

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

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

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

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

说明 若指定了 SDGIds,同时指定了 InstanceIds,则查询结果为上述两个条件的交集。
["aic-1", "aic-2", "aic-3"]

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

SDG 信息列表。

AvaliableRegionIdsobject []

可用节点列表。

CreationTimestring

该节点内 SDG 的创建时间。

2023-02-27 15:13:26
RegionIdstring

节点 ID。

cn-hangzhou-26
SnapshotIdstring

快照 ID。

mock-clone_snapshot_id
Statusstring

该节点 SDG 的状态,包括:

  • sdg_making:制作中。
  • sdg_saving:保存中。
  • sdg_copying:跨节点同步中。
  • failed:制作失败。
  • success:制作成功。
success
CreationInstanceIdstring

创建 SDG 的实例 ID。

aic-5x20dyeos****
CreationRegionIdstring

创建 SDG 的节点 ID。

cn-hangzhou-26
CreationTimestring

SDG 首次创建时间。

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

部署状态信息列表

CreationTimestring

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

2023-02-27 16:48:43
InstanceIdstring

实例 ID。

aic-5x20dyeos****
Statusstring

部署状态,包括:

  • sdg_deploying:部署中。
  • failed:部署失败。
  • success:部署成功。
sdg_deploying
DeploymentTypestring

SDG 部署类型,包括:

  • common: 普通部署
  • overlay: 读写分离部署
overlay
Descriptionstring

SDG 的描述信息。

测试SDG
ParentSDGIdstring

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

sdg-xxxxx
SDGIdstring

SDG 的 ID。

sdg-30e1fdba7196bc****
Sizelong

SDG 大小,单位 GB。

20
Statusstring

SDG 制作状态,包括:

  • sdg_making:制作中。
  • sdg_saving:保存中。
  • failed:制作失败。
  • success:制作成功。
success
UpdateTimestring

SDG 最后更新时间。

2023-02-27 16:04:39

示例

正常返回示例

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

错误码

HTTP status code错误码错误信息描述
400Interface.Call.Failed%s.请求失败
400Parameter.InvalidThe parameter is invalid. Please check your parameters and try it again.参数不合法
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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

变更历史

变更时间变更内容概要操作
2024-04-24OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
  • 本页导读 (1)