检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 204 APIG.0000 Successful 请求成功 无 400 APIC.7211 Parameter
查看分组下指定错误类型的自定义响应 功能介绍 查看分组下指定错误类型的自定义响应 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gatew
绑定域名证书 功能介绍 如果创建API时,“定义API请求”使用HTTPS请求协议,那么在独立域名中需要添加SSL证书。 本章节主要介绍为特定域名绑定证书。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
绑定域名 功能介绍 用户自定义的域名,需要CNAME到API分组的子域名上才能生效,具体方法请参见增加A类型记录集。 每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
查看专享版实例详情 功能介绍 查看专享版实例详情 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查询分组自定义响应列表 功能介绍 查询分组自定义响应列表 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gateway-responses
响应消息头 调用API时,API网关增加如下响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关调试信息。 响应消息头 描述 说明 X-Request-Id 请求ID 所有合法请求,都会返回此参数 X-Apig-Latency 从API网关接收请求到后端返回消息头的用时
删除域名证书 功能介绍 如果域名证书不再需要或者已过期,则可以删除证书内容。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/api-groups/{group_id}
修改分组下指定错误类型的自定义响应 功能介绍 修改分组下指定错误类型的自定义响应。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/gate
查询分组列表 功能介绍 查询API分组列表。 如果是租户操作,则查询该租户下所有的分组;如果是管理员权限账号操作,则查询的是所有租户的分组。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups
绑定域名证书 功能介绍 如果创建API时,“定义API请求”使用HTTPS请求协议,那么在独立域名中需要添加SSL证书。 本章节主要介绍为特定域名绑定证书。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
APIG的API响应消息头说明 调用API时,API网关增加下表中的响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关调试信息。 响应消息头 描述 X-Request-Id 请求ID。所有合法请求,都会返回此参数。 X-Apig-Latency 从AP
域名解绑SSL证书 功能介绍 域名解绑SSL证书。目前暂时仅支持单个解绑,请求体当中的certificate_ids里面有且只能有一个证书ID。在使用自定义入方向端口的特性时,相同的域名会同时解绑证书。 调用方法 请参见如何调用API。 URI POST /v2/{project
查看分组详情 功能介绍 查询指定分组的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/api-groups/{id}
域名绑定SSL证书 功能介绍 域名绑定SSL证书。目前暂时仅支持单个绑定,请求体当中的certificate_ids里面有且只能有一个证书ID。使用实例自定义入方向端口的特性时,相同的域名会同时绑定证书,注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 调用方法 请参见如何调用API。
错误码 当调用API时,可能遇到如表1所示的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。 使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非固定不变,有时会对错误信息进行优化修改。
删除域名证书 功能介绍 如果域名证书不再需要或者已过期,则可以删除证书内容。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1/{project_id}/apigw/instances/
查询分组详情 功能介绍 查询指定分组的详细信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id} 表1 路径参数 参数 是否必选 参数类型 描述
修改ACL策略 功能介绍 修改指定的ACL策略,其中可修改的属性为:acl_name、acl_type、acl_value,其它属性不可修改。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/acls/{acl_id}
返回结果 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见HTTP状态码。 对于创建API分组(专享版API)接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头