DescribeSDGDeploymentStatus - 查询SDG部署状态

调用DescribeSDGDeploymentStatus查询SDG的部署状态。

调试

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

授权信息

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

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

请求参数

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

SDG 的 ID。

sdg-xxxx
PageNumberinteger

页码,起始值为:1,默认值:1

1
PageSizeinteger

每页行数。

10

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID

68B85217-03B8-5141-9216-EA4D7C496B9A
DeploymentStatusarray<object>

SDG 部署信息列表

DeploymentStatusobject
InstanceIdstring

AIC 实例 ID。

aic-xxxx
MountTypestring

部署类型

枚举值:
  • overlay读写分离部署
  • common普通部署
overlay
RegionIdstring

节点 ID。

cn-hangzhou
Statusstring

SDG 部署状态

枚举值:
  • sdg_deploying部署中
  • success部署成功
  • failed部署失败
success
UpdateTimestring

最新的状态更新时间。

2023-02-17T02:44:31Z
PageNumberlong

页码,起始值为 1。默认值:1。

1
PageSizelong

分页查询时设置的每页行数,默认值为 10

10
TotalCountlong

查询到的部署记录总数。

100

示例

正常返回示例

JSON格式

{
  "RequestId": "68B85217-03B8-5141-9216-EA4D7C496B9A",
  "DeploymentStatus": [
    {
      "InstanceId": "aic-xxxx",
      "MountType": "overlay",
      "RegionId": "cn-hangzhou",
      "Status": "success",
      "UpdateTime": "2023-02-17T02:44:31Z"
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 100
}

错误码

HTTP status code错误码错误信息描述
400Interface.Call.Failed%s.请求失败
400Interface.Call.ErrorThe interface call error接口调用出错
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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

变更历史

变更时间变更内容概要操作
2024-08-13OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情