使用DescribeAbolishApiTask查询API下线任务进度-API 网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

查询API下线任务的进度。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

apigateway:DescribeAbolishApiTask

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
OperationUid	string	是	下线操作 ID	fc54**dd4c4ad7edd7***39401

返回参数

名称	类型	描述	示例值
	object
RequestId	string	本次请求的 ID。	E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99
ApiAbolishResults	object
ApiAbolishResult	array<object>	返回结果
	object	返回结果
StageId	string	运行环境编号	0919f2854a88484c91dc9253347c78f9
AbolishStatus	string	下线状态	OVER
GroupId	string	API 分组 ID	160cb6505e1c43a6b84346856d74eb47
GroupName	string	API 分组名称	wb2022021401619286
ApiUid	string	API 唯一标识	4e26cdbbb113416dba1f0285bed29979
ErrorMsg	string	错误信息。	Success. Request Success.
StageName	string	环境名称，枚举为： RELEASE：线上 TEST：测试	RELEASE
ApiName	string	API 名称	v2_page_consent

示例

正常返回示例

JSON格式

{
  "RequestId": "E8515BA6-81CD-4191-A7CF-C4FCDD3C0D99",
  "ApiAbolishResults": {
    "ApiAbolishResult": [
      {
        "StageId": "0919f2854a88484c91dc9253347c78f9",
        "AbolishStatus": "OVER",
        "GroupId": "160cb6505e1c43a6b84346856d74eb47",
        "GroupName": "wb2022021401619286",
        "ApiUid": "4e26cdbbb113416dba1f0285bed29979",
        "ErrorMsg": "Success. Request Success.",
        "StageName": "RELEASE",
        "ApiName": "v2_page_consent"
      }
    ]
  }
}

错误码

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

变更历史

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