文档

DescribeDeployApiTask - 查询发布API任务进度

更新时间:

查询发布API的异步任务的进度。

调试

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

授权信息

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

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

请求参数

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

任务 ID

51524fb8f12846d694d0a1de9a0cf274

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

CA4B3261-F14A-5E33-8608-F75A1DF27AD4
DeployedResultsobject []

返回结果

ErrorMsgstring

错误信息

Success. Request Success.
StageNamestring

指定要查询的环境。

  • RELEASE:线上
  • TEST:测试
RELEASE
GroupIdstring

API 分组编号

e8da6f6346184da9a30d0dc1888b1f3b
ApiUidstring

API 唯一标识

0433c1cd84724923b7a4f9ca1cfc249c
DeployedStatusstring

部署状态

OVER

示例

正常返回示例

JSON格式

{
  "RequestId": "CA4B3261-F14A-5E33-8608-F75A1DF27AD4",
  "DeployedResults": {
    "DeployedResult": [
      {
        "ErrorMsg": "Success. Request Success.",
        "StageName": "RELEASE",
        "GroupId": "e8da6f6346184da9a30d0dc1888b1f3b",
        "ApiUid": "0433c1cd84724923b7a4f9ca1cfc249c",
        "DeployedStatus": "OVER"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)