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

查询SDG基本信息，包括节点预加载信息等。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
ens:DescribeSDG	none	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
SDGIds	array	否	指定查询若干 SDG，默认查询全部。
	string	否	指定查询若干 SDG，默认查询全部。	["sdg-1", "sdg-2", "sdg-3"]
PageNumber	integer	否	分页查询的页码。	1
PageSize	integer	否	分页查询时设置的每页行数。默认值：10。	10

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	F3B261DD-3858-4D3C-877D-303ADF374600
SDGs	array<object>	SDG 信息列表。
SDGs	object
AvaliableRegionIds	array<object>	SDG 存在快照的列表。
AvaliableRegionIds	object
CreationTime	string	该节点内 SDG 的创建时间。	2023-02-27 15:13:26
RegionId	string	节点 ID。	cn-hangzhou-26
SnapshotId	string	快照 ID。	sp-517qu0tgznrg622he7nf4wd7n
Status	string	该节点 SDG 的状态，包括： sdg_making：制作中。 sdg_saving：保存中。 sdg_copying：跨节点同步中。 failed：制作失败。 success：制作成功。	success
CreationInstanceId	string	创建 SDG 的实例 ID。	aic-5x20dyeos****
CreationRegionId	string	创建 SDG 的节点 ID。	cn-hangzhou-26
CreationTime	string	SDG 首次创建时间。	2023-02-27 15:07:21
Description	string	SDG 的描述信息。	测试SDG
ParentSDGId	string	增量制作时，来源 SDG 的 ID，即 CreateSDG 时传入的 FromSDGId。	sdg-xxxxx
SDGId	string	SDG 的 ID。	sdg-30e1fdba7196bc****
Size	long	SDG 大小，单位 GB。	20
Status	string	SDG 制作状态，包括： sdg_making：制作中。 sdg_saving：保存中。 failed：制作失败。 success：制作成功。	success
UpdateTime	string	SDG 最后更新时间。	2023-02-27 16:04:39
PreloadInfos	array<object>	预加载配置信息
PreloadInfos	object
RegionId	string	节点 ID。	cn-hangzhou
Namespace	string	命名空间。	test-20000
RedundantNum	integer	冗余数量，以快速响应共享挂载。	2
CreationTime	string	创建时间。时间格式以 ISO8601 为标准，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2023-02-16T06:18:40Z
UpdateTime	string	最新的状态更新时间。	2021-01-22T08:17Z
PageNumber	integer	当前查询页码。	1
PageSize	integer	当前查询每页的行数。	10
TotalCount	integer	总数。	49

示例

正常返回示例

JSON格式

{
  "RequestId": "F3B261DD-3858-4D3C-877D-303ADF374600",
  "SDGs": [
    {
      "AvaliableRegionIds": [
        {
          "CreationTime": "2023-02-27 15:13:26",
          "RegionId": "cn-hangzhou-26",
          "SnapshotId": "sp-517qu0tgznrg622he7nf4wd7n",
          "Status": "success"
        }
      ],
      "CreationInstanceId": "aic-5x20dyeos****",
      "CreationRegionId": "cn-hangzhou-26",
      "CreationTime": "2023-02-27 15:07:21",
      "Description": "测试SDG",
      "ParentSDGId": "sdg-xxxxx",
      "SDGId": "sdg-30e1fdba7196bc****",
      "Size": 20,
      "Status": "success",
      "UpdateTime": "2023-02-27 16:04:39",
      "PreloadInfos": [
        {
          "RegionId": "cn-hangzhou",
          "Namespace": "test-20000",
          "RedundantNum": 2,
          "CreationTime": "2023-02-16T06:18:40Z",
          "UpdateTime": "2021-01-22T08:17Z"
        }
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 49
}

错误码

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

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