检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
配置API的自定义认证 配置API的前端自定义认证 配置API的后端自定义认证 父主题： 管理API
怎样保护API的调用安全？ 使用身份认证 创建API时，为API调用增加身份认证，如使用IAM认证或API网关提供的APP认证，防止API被恶意调用。 设置访问控制策略 从IP地址（或地址区间）以及账号等不同维度，设置白名单/黑名单。 将API绑定流控策略，通过流控策略保护API。
API的响应码如何定义？ API响应码分两种类型。 一种是网关响应码。当请求到达网关时，由于API的流量控制、访问控制策略以及认证失败，网关直接返回的响应信息。有关网关响应的详细指导，请参考自定义API的错误响应信息。 一种是后端服务响应。响应信息由后端API服务（即API的提供者）定义，API网关只做透传。
符合条件的APP总数 size Integer 本次返回的列表长度 auths 字典数据类型 本次返回的APP列表 表4 auths参数说明 名称 类型 说明 id String 授权关系编号 api_id String API的编号 api_name String API的名称 group_name
新增实例的自定义入方向端口 功能介绍 新增实例的自定义入方向端口，在同个实例中，一个端口仅能支持一种协议。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/custom-ingress-ports
查看APP已绑定的API列表 功能介绍 查询APP已经绑定的API列表。 将API发布到相应的授权的环境后，才能查询到结果。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{projec
删除实例指定的自定义入方向端口 功能介绍 删除实例指定的自定义入方向端口，不包含默认端口80和443。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/custom-ingres
api_id 是 String api的ID。 throttle_id 否 String 流控策略的编号 throttle_name 否 String 流控策略的名称 env_id 否 String 绑定的环境编号 page_size 否 Integer 每页显示的条数，默认值：20 page_no
Integer 剩余访问次数 quota_used Integer 已使用访问次数 app_key String 生成的APP的key app_secret String 生成的APP的secret 响应参数样例： { "total": 3, "size": 3, "purchases":
Token的值）。 响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 acls Array of ApiBindAclInfo objects 本次查询返回的ACL列表 表5
怎样给指定的用户开放API？ 可以采用以下两种方式： 创建API时可选取APP认证方式，AppKey和AppSecret分享给指定的用户。 使用访问控制策略，按照IP地址或者账号名，只允许符合允许策略的用户调用API。 父主题： API策略
配置API认证凭据的配额控制 凭据配额可限制单位时间内凭据调用API的总次数，保护后端服务。您可以创建凭据配额策略，对绑定策略的凭据进行调用次数限制。 凭据配额策略和凭据本身是相互独立的，只有将凭据绑定凭据配额策略后，凭据配额策略才对凭据生效。 操作步骤 进入API网关控制台页面。
置。如需自定义跨域的请求头、跨域的请求方法和指定授权访问的域，请使用配置API的跨域资源共享。 简单请求的跨域访问 如果是创建新的API，在“安全配置”时，勾选“开启支持跨域（CORS）”开关。详细的使用指导，可参考简单请求。 非简单请求的跨域访问 非简单请求的跨域访问可通过两种配置方式实现，选择其中一种配置即可。
前端自定义认证响应的context映射的指定键值对的字符串值 $context.authorizer.backend.property 后端自定义认证响应的context映射的指定键值对的字符串值 $context.error.message 当前网关错误响应的错误信息 $context
查看或编辑APIG的API信息 API列表支持查看或编辑当前实例下所有的API，查看或编辑API的运行环境、请求方法、请求路径等信息。 查看或编辑API信息 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API列表”，您可以
APIG的API设计文件扩展定义 x-apigateway-auth-type x-apigateway-request-type x-apigateway-match-mode x-apigateway-cors x-apigateway-is-send-fg-body-base64
APIG的API错误码说明 当调用API时，可能遇到下表中的错误码。如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 通过APIG接口管理API，发生错误时，产生的错误码请参考错误码。 使用APIG错误码时，请以错误码（如APIG.0101）为准，错误信息并非
调试API的时候，如何指定环境？ 调试API时，默认使用APIG特定的debug环境，因此不能指定其他环境。 调试完成后，需将API发布到对应环境上，再使用代码或者postman等工具，并添加请求消息头X-Stage，才能访问指定环境。 父主题： 发布API
run_env_name String 发布的环境名 run_env_id String 发布的环境id publish_id String API发布记录编号 acl_name String 绑定的其他同类型的ACL策略名称 req_uri String API的访问地址 auth_type String
String 发布记录的编号 throttle_apply_id String 与流控策略的绑定关系编号 throttle_name String 绑定的流控策略名称 apply_time Timestamp 与已绑定的流控策略的绑定时间 auth_type String API的认证方式 req_uri
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
