DescribeSDGs - 查询SDG信息 - 边缘节点服务ENS

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ens:DescribeSDGs

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
SDGIds	array	否	待查询的 SDG 列表 ID。
	string	否	指定查询的 SDG ID。若参数值为空，默认查询全部。	["sdg-1", "sdg-2", "sdg-3"]
InstanceIds	array	否	待查询的 AIC 实例 ID。
	string	否	指定查询的 AIC 实例 ID，若参数值为空，默认查询全部。说明若指定了 SDGIds，同时指定了 InstanceIds，则查询结果为上述两个条件的交集。	["aic-1", "aic-2", "aic-3"]

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	3703C4AC-9396-458C-8F25-1D701334D309
SDGs	array<object>	SDG 信息列表。
	array<object>	SDG 信息列表。
AvaliableRegionIds	array<object>	可用节点列表。
	object	可用节点列表。
CreationTime	string	该节点内 SDG 的创建时间。	2023-02-27 15:13:26
RegionId	string	节点 ID。	cn-hangzhou-26
SnapshotId	string	快照 ID。	mock-clone_snapshot_id
Status	string	该节点 SDG 的状态，包括： sdg_making：制作中。 sdg_saving：保存中。 sdg_copying：跨节点同步中。 failed：制作失败。 success：制作成功。	success
CreationDiskType	string	创建 SDG 的母盘磁盘类型。	standard
CreationRegionId	string	创建 SDG 的节点 ID。	cn-hangzhou-26
CreationTime	string	SDG 首次创建时间。	2023-02-27 15:07:21
DeployedInstanceIds	array<object>	部署状态信息列表
	object	部署状态信息列表
CreationTime	string	SDG 在该实例上的部署时间。	2023-02-27 16:48:43
InstanceId	string	AIC 实例 ID。	aic-5x20dyeos****
Status	string	部署状态，包括： sdg_deploying：部署中。 failed：部署失败。 success：部署成功。	sdg_deploying
DeploymentType	string	SDG 部署类型，包括： common: 普通部署 overlay: 读写分离部署	overlay
Description	string	SDG 的描述信息。	Test SDG
ParentSDGId	string	增量制作时，来源 SDG 的 ID，即 CreateSDG 时传入的 FromSDGId。	sdg-xxxxx
SDGId	string	SDG 的 ID。	sdg-30e1fdba7196bc****
Size	integer	SDG 大小，单位 GB。	20
Status	string	SDG 制作状态，包括： sdg_making：制作中。 sdg_saving：保存中。 failed：制作失败。 success：制作成功。	success
UpdateTime	string	SDG 最后更新时间。	2023-02-27 16:04:39
CreationInstanceId	string	创建 SDG 的实例 ID。	aic-5x20dyeos****
BillingType	string	计费类型	Open
PerformanceLevel	integer	SDG 的共享比。	100
BillingCycle	string	共享盘的计费周期。	Hour

示例

正常返回示例

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"
        }
      ],
      "CreationDiskType": "standard",
      "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": "Test SDG",
      "ParentSDGId": "sdg-xxxxx",
      "SDGId": "sdg-30e1fdba7196bc****",
      "Size": 20,
      "Status": "success",
      "UpdateTime": "2023-02-27 16:04:39",
      "CreationInstanceId": "aic-5x20dyeos****",
      "BillingType": "Open",
      "PerformanceLevel": 100,
      "BillingCycle": "Hour"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	Interface.Call.Failed	%s.	请求失败
400	Parameter.Invalid	The parameter is invalid. Please check your parameters and try it again.	参数不合法
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

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

变更历史

更多信息，参考变更详情。