使用DescribeUpdateBackendTask查询后端服务变更后的API更新结果-API 网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

修改后端服务在某个环境上的定义时，关联的已发布API会批量更新，该接口用来查询更新的结果。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

apigateway:DescribeUpdateBackendTask

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
OperationUid	string	是	任务 ID	4e13c3e0c44c4a4ebb5231264eeb9bc1

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID	CEF72CEB-54B6-4AE8-B225-F876FF7BZ016
ApiUpdateBackendResults	object
ApiUpdateBackendResult	array<object>	API 的更新结果
	object	API 的更新结果
StageId	string	运行环境编号	d8f2f54f3309458b8aaceb36c01c2dd9
UpdateStatus	string	API 更新结果	OVER
GroupName	string	分组名称	imotob1
GroupId	string	分组 ID	3013a55c0c44483f984d26df27120513
ApiUid	string	API 的 ID	14faa7ba0572445685866ddb6a6f19da
ErrorMsg	string	更新失败的错误信息	Failed
StageName	string	环境名称	RELEASE
ApiName	string	API 名称	checkin_linechart_today
BackendId	string	后端服务 ID	c09b078bcb8f4ade9677bd8b18cdf43f

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ016",
  "ApiUpdateBackendResults": {
    "ApiUpdateBackendResult": [
      {
        "StageId": "d8f2f54f3309458b8aaceb36c01c2dd9",
        "UpdateStatus": "OVER",
        "GroupName": "imotob1",
        "GroupId": "3013a55c0c44483f984d26df27120513",
        "ApiUid": "14faa7ba0572445685866ddb6a6f19da",
        "ErrorMsg": "Failed",
        "StageName": "RELEASE",
        "ApiName": "checkin_linechart_today",
        "BackendId": "c09b078bcb8f4ade9677bd8b18cdf43f"
      }
    ]
  }
}

错误码

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

变更历史

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