检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
类型 说明 api_id String 发布或下线失败的API ID api_name String 发布或下线失败的API名称 error_code String 发布或下线失败的错误码 error_msg String 发布或下线失败的错误信息 响应消息样例： { "success":
AUTH_FAILURE: 认证失败，IAM或APP认证校验失败 AUTH_HEADER_MISSING: 认证身份来源信息缺失 AUTHORIZER_FAILURE: 自定义认证方返回认证失败 AUTHORIZER_CONF_FAILURE:自定义认证方异常，通信失败、返回异常响应等错误
API可以被发布到不同的环境中。比如RELEASE和BETA两个环境，分别代表线上和测试环境。 应用（凭据）指代一个API调用者的身份。创建应用（凭据）时，系统会自动生成用于认证该身份的应用（凭据）key&secret。将指定的API授权给指定应用（凭据）后，该应用（凭据）的持有者才可以调用已发布到环境中的指定API。
凭据的Key和Secret进行安全认证，也可以通过AppCode进行简易认证。 配置APIG的API认证凭据 在API网关中创建一个凭据，生成密钥对（Key、Secret），在调用API时，API网关服务根据密钥对进行身份核对，完成鉴权。Key唯一且不可重置，支持重置Secret。
类型 说明 api_id String 发布或下线失败的API ID api_name String 发布或下线失败的API名称 error_code String 发布或下线失败的错误码 error_msg String 发布或下线失败的错误信息 响应消息样例： { "success":
线，中划线，且只能以英文字母或数字开头，8 ~ 32字符。未填写时后台自动生成。 basic类型的签名密钥key：支持英文，数字，下划线，中划线，且只能以英文字母开头，4 ~ 32字符。未填写时后台自动生成。 public_key类型的签名密钥key：支持英文，数字，下划线，中划
参数名 参数的名称，如果参数在“Path”位置，参数名称会同步“路径”中的名称。 参数名不能以x-apig- 、x-sdk-开头，不能是x-stage，不区分大小写。 参数位置为HEADER时，参数名不能是“Authorization”和“X-Auth-Token”，不区分大小写，也不支持下划线。
线，中划线，且只能以英文字母或数字开头，8 ~ 32字符。未填写时后台自动生成。 basic类型的签名密钥key：支持英文，数字，下划线，中划线，且只能以英文字母开头，4 ~ 32字符。未填写时后台自动生成。 public_key类型的签名密钥key：支持英文，数字，下划线，中划
线，中划线，且只能以英文字母或数字开头，8 ~ 32字符。未填写时后台自动生成。 basic类型的签名密钥key：支持英文，数字，下划线，中划线，且只能以英文字母开头，4 ~ 32字符。未填写时后台自动生成。 public_key类型的签名密钥key：支持英文，数字，下划线，中划
下线API 操作场景 已发布的API因为其他原因需要暂停对外提供服务，可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问，请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入共享版控制台。
下线APIG的API 已发布的API因为其他原因需要暂停对外提供服务，可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问，请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API网关控制台页面。
调用API所使用的域名、请求方法、路径不正确。 比如创建的API为POST方法，您使用了GET方法调用。 比如访问的URL比API详情中的URL少一个“/”也会导致无法匹配上此API，例如http://7383ea59c0cd49a2b61d0fd1d351a619.apigw.region.cloud.
方案优势 所有Region都可以配置。 可指定保底带宽和弹性带宽。 约束与限制 对接高防后，如果开启了WEB基础防护或者CC防护，APIG将无法透传真实源IP。 需修改域名的IP，必须使用高防IP。 需依赖公网DNS进行域名切换。 业务带宽需收费。 域名切换有短暂时间间隔，可能会导致网络中断。
错误类型的响应定义，其中key为错误类型。key的枚举值为： AUTH_FAILURE：认证失败 AUTH_HEADER_MISSING：认证身份来源缺失 AUTHORIZER_FAILURE：自定义认证失败 AUTHORIZER_CONF_FAILURE：自定义认证配置错误 AUTHOR
创建应用并获取授权 操作场景 使用APP认证的API，需要在API网关中创建一个应用，以生成应用ID和密钥对（AppKey、AppSecret）。将创建的应用绑定API后，才可以使用APP认证调用API。在API调用过程中，把密钥对替换SDK中的密钥对，API网关服务根据密钥对进
APIG提供了传统策略：流量控制，从API、用户、凭据、源IP等多个维度进行流控。 然而，随着用户多样性以及需求多样性的增加，传统流控策略无法满足更加精细的流量控制场景。比如针对某一请求参数的流控或者某一租户的流控，APIG在传统流量控制策略的基础上提供了插件策略：流量控制2.0，通过制定更加精细的方案来进行流控。
参数类型 描述 api_id String 发布或下线失败的API ID api_name String 发布或下线失败的APi名称 error_code String 发布或下线失败的错误码 error_msg String 发布或下线失败的错误信息 状态码： 400 表8 响应Body参数
终端节点服务的名称。 支持英文、数字、中划线、下划线，0~16个字符。 如果您不填写该参数，系统生成的终端节点服务的名称为{region}.apig.{service_id}。 如果您填写该参数，系统生成的终端节点服务的名称为{region}.{vpcep_service_name}.{service_id}。
母开头，8 ~ 32字符。 未填写时后台自动生成。 sign_secret 否 String 签名密钥的密钥。 支持英文，数字，下划线，中划线，!，@，#，$，%，且只能以数字或英文字母开头，16 ~ 64字符。 未填写时后台自动生成。 请求消息样例： { "name": "signature01"
错误类型的响应定义，其中key为错误类型。key的枚举值为： AUTH_FAILURE：认证失败 AUTH_HEADER_MISSING：认证身份来源缺失 AUTHORIZER_FAILURE：自定义认证失败 AUTHORIZER_CONF_FAILURE：自定义认证配置错误 AUTHOR
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
