文档首页/API网关 APIG/API参考/专享版API（V2）/专享版-分组自定义响应管理/查询分组自定义响应列表 - ListGatewayResponsesV2
更新时间：2025-12-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询分组自定义响应列表 - ListGatewayResponsesV2

功能介绍

查询分组自定义响应列表

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    apig:apiGroup:listGatewayResponse

    List

    instance *

    g:ResourceTag/<tag-key>

    • apig:gatewayResponses:list
    • apig:instance:get
    • apig:apiGroup:get

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID，在API网关控制台的“实例信息”中获取。

group_id

是

String

分组的编号

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Long

偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0

缺省值：0

limit

否

Integer

每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500

最小值：1

最大值：500

缺省值：20

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

size

Integer

本次返回的列表长度

total

Long

满足条件的记录数

responses

Array of ResponsesInfo objects

响应列表

表5 ResponsesInfo

参数

参数类型

描述

name

String

响应名称

responses

Map<String,ResponseInfoResp>

错误类型的响应定义，其中key为错误类型。key的枚举值为：

  • AUTH_FAILURE：认证失败

  • AUTH_HEADER_MISSING：认证身份来源缺失

  • AUTHORIZER_FAILURE：自定义认证失败

  • AUTHORIZER_CONF_FAILURE：自定义认证配置错误

  • AUTHORIZER_IDENTITIES_FAILURE：自定义认证身份来源错误

  • BACKEND_UNAVAILABLE：后端不可用

  • BACKEND_TIMEOUT：后端超时

  • THROTTLED：调用次数超出阈值

  • UNAUTHORIZED：应用未授权

  • ACCESS_DENIED：拒绝访问

  • NOT_FOUND：未找到匹配的API

  • REQUEST_PARAMETERS_FAILURE：请求参数错误

  • DEFAULT_4XX：默认4XX

  • DEFAULT_5XX：默认5XX

  • THIRD_AUTH_FAILURE: 第三方认证失败

  • THIRD_AUTH_IDENTITIES_FAILURE: 第三方认证身份来源错误

  • THIRD_AUTH_CONF_FAILURE: 第三方认证配置错误

  • OIDC_AUTH_TOKEN_VERIFY_FAIL: OIDC认证中token校验失败

  • OIDC_AUTH_GET_DISCOVERY_ERROR: OIDC认证中从配置的discovery处获取信息失败

  • OIDC_AUTH_CODE_FLOW_FAIL: OIDC认证中授权码流程处理失败

  • JWT_AUTH_FAILURE: JWT认证中token校验失败

  • ORCHESTRATION_PARAMETER_NOT_FOUND: 没有入参进行参数编排规则匹配，参数编排失败

  • ORCHESTRATION_FAILURE: 有入参进行参数编排规则匹配，但是匹配不上编排规则，参数编排失败

每项错误类型均为一个JSON体

id

String

响应ID

default

Boolean

是否为分组默认响应

create_time

String

创建时间

update_time

String

修改时间

表6 ResponseInfoResp

参数

参数类型

描述

status

Integer

响应的HTTP状态码。范围为200-599，但不允许为444。

body

String

响应的Body模板

headers

Array of ResponseInfoHeader objects

自定义的响应头

数组长度：0 - 10

default

Boolean

是否为默认响应

表7 ResponseInfoHeader

参数

参数类型

描述

key

String

分组自定义响应的响应头的key，支持英文字母、数字和中划线，长度为1到128位

value

String

分组自定义响应的响应头的value，为长度为1到1024位的字符串

最小长度：1

最大长度：1024

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：403

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：404

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

无

响应示例

状态码：200

OK

{
  "total" : 2,
  "size" : 2,
  "responses" : [ {
    "create_time" : "2020-08-12T06:52:02Z",
    "default" : false,
    "id" : "e839b367e10f4ab19d1c5008e476b83a",
    "name" : "response_demo",
    "update_time" : "2020-08-12T06:52:02Z"
  }, {
    "create_time" : "2020-07-31T11:39:23Z",
    "default" : true,
    "id" : "ed8e8c52ab0e4a1c9c809268e5002e64",
    "name" : "default",
    "update_time" : "2020-07-31T11:39:23Z"
  } ]
}

状态码：400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:group_id. Please refer to the support documentation"
}

状态码：401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码：403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

状态码：404

Not Found

{
  "error_code" : "APIG.3001",
  "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist"
}

状态码：500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。