检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
自定义API的错误响应信息 网关响应指API网关未能成功处理API请求，从而产生的错误响应。API网关提供默认的网关响应（default），如果您需要自定义响应状态码或网关响应内容，可在API分组管理中新增网关响应，其中响应内容符合JSON格式即可。 例如，“default”网关的响应内容为：
SIGN_NUM_LIMIT：租户可以创建的签名密钥个数限制 THROTTLE_NUM_LIMIT：租户可以创建的流控策略个数限制 APIGROUP_DOMAIN_NUM_LIMIT：每个API分组上可以绑定的自定义域名个数限制 API_VERSION_NUM_LIMIT：每个API可以保留的发布版本个数限制
对应字段是否为必选字段。 表1 域名对象模型 参数 类型 说明 操作类型 是否必选 id String 域名的编号 R - url_domain String 自定义域名 CR 是 cname_status Integer cname解析状态 1 未解析 2 解析中 3 解析成功
配置APIG的终端节点信息 终端节点用于在VPC和终端节点服务之间建立便捷、安全、私密的连接通道。 在同一区域中，可实现云内跨VPC访问/开放API。 图1 同一区域跨VPC访问 约束与限制 目前除墨西哥城一、北京一区域外，其他区域都支持终端节点管理功能。 配置终端节点信息 进入API网关控制台页面。
对应字段是否为必选字段。 表1 域名对象模型 参数 类型 说明 操作类型 是否必选 id String 域名的编号 R - url_domain String 自定义域名 CR 是 cname_status Integer cname解析状态 1 未解析 2 解析中 3 解析成功
缺省响应，描述未定义的响应码 status_code 否 Object 响应状态码，值为响应对象，参考表11 x-apigateway-result-failure-sample 否 String 失败返回示例，描述API的异常返回信息 x-apigateway-result-normal-sample
查看APP详情 功能介绍 查看指定APP的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps/{id} URI中的参数说明如下表所示。 表2 参数说明 名称
The request message containing the user's name. message HelloRequest { string name = 1; } // The response message containing the greetings message
API请求体描述，可以是请求体示例、媒体类型、参数等信息 result_normal_sample String 正常响应示例，描述API的正常返回信息 result_failure_sample String 失败返回示例，描述API的异常返回信息 backend_api 字典数据类型 后端服务：web后端详情
总记录数 表8 TmsResourceResp 参数 参数类型 描述 resource_id String 实例编号 resouce_detail String 实例详细描述。暂不支持 resource_name String 实例名称 tags Array of TmsKeyValue
缺省响应，描述未定义的响应码 status_code 否 Object 响应状态码，值为响应对象，参考表11 x-apigateway-result-failure-sample 否 String 失败返回示例，描述API的异常返回信息 x-apigateway-result-normal-sample
对象模型 本节介绍流控策略的对象模型，如下表所示： “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 流控对象模型 参数 类型 说明 操作类型 是否必选
对象模型 本节介绍流控策略的对象模型，如下表所示： “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 流控对象模型 参数 类型 说明 操作类型 是否必选
重置密钥 功能介绍 重置指定APP的密钥。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/apps/secret/{id} URI中的参数说明如下表所示。 表2 参数说明
查看域名证书 功能介绍 查看域名下绑定的证书详情。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/api-groups/{group_id}/domains/{domain
查看APP详情 功能介绍 查看指定APP的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/apps/{id}
查询APP列表 功能介绍 查询APP列表。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/apps 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
新增网关响应 操作场景 网关响应，指API网关未能成功处理API请求，从而产生的错误响应。API网关提供默认的网关响应（default），如果您需要自定义响应状态码或网关响应内容，可在API分组管理中新增网关响应，其中响应内容符合JSON格式即可。 例如，“default”网关的响应内容为：
黑白名单的编号 R - acl_name String 黑白名单的名称 CRU 是 entity_type String 对象类型 IP DOMAIN （租户名称） CRU 是 acl_type String 黑白名单的类型 PERMIT (白名单) DENY (黑名单) CRU 是 acl_value
缺省响应，描述未定义的响应码 status_code 否 Object 响应状态码，值为响应对象，参考表11 x-apigateway-result-failure-sample 否 String 失败返回示例，描述API的异常返回信息 x-apigateway-result-normal-sample
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
