检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
variable_name String 变量名,支持英文字母、数字、英文格式的下划线、中划线,必须以英文字母开头,3~32个字符。在API定义中等于#Name的值#部分(区分大小写),发布到环境里的API被变量值替换。 说明: 中文字符必须为UTF-8或者unicode编码。 id String
密钥名称 自定义名称,用于识别不同的密钥。 类型 专享版支持选择签名密钥的认证类型,可选择“HMAC”和“Basic”。 Key 与“Secret”配合使用,表示签名密钥对。 HMAC:填写hmac认证所使用密钥对的Key。 Basic:填写basic认证所使用的用户名。 Secret
配置。 简单请求的跨域访问 如果是创建新的API,在定义API请求时,打开“支持跨域(CORS)”开关。详细的使用指导,可参考简单请求。 图2 支持跨域 非简单请求的跨域访问 非简单请求的跨域访问需要在API的分组中创建一个“Method”为“OPTIONS”的API,作为预检请求。
String API的编号,可通过查询API信息获取该编号。 请求消息 表3 参数说明 参数 是否必选 类型 说明 group_id 否 String API所属分组的编号,该值不可修改 name 是 String API名称 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头
添加一个API,API即一个服务接口,具体的服务能力。 API分为两部分,第一部分为面向API使用者的API接口,定义了使用者如何调用这个API。第二部分面向API提供者,由API提供者定义这个API的真实的后端情况,定义了API网关如何去访问真实的后端服务。 API的真实后端服务目前支持三种类型:传统的HTTP
APIG的API错误码说明 当调用API时,可能遇到下表中的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。 使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非
应用场景 当用户后端服务器所在的VPC与创建实例所选择的VPC处于不同的场景时,该如何完成服务配置,以实现跨VPC对接?本文以Elastic Load Balance(弹性负载均衡ELB)为例,讲述如何在API网关上开放内网ELB中的服务。 方案架构 图1 API网关跨VPC开放后端服务
String API的编号,可通过查询API信息获取该编号。 请求消息 表3 参数说明 参数 是否必选 类型 说明 group_id 否 String API所属分组的编号,该值不可修改 name 是 String API名称 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头
创建签名密钥 功能介绍 为了保护API的安全性,建议租户为API的访问提供一套保护机制,即租户开放的API,需要对请求来源进行认证,不符合认证的请求直接拒绝访问。 其中,签名密钥就是API安全保护机制的一种。 租户创建一个签名密钥,并将签名密钥与API进行绑定,则API网关在请求
标签键:支持可用UTF-8格式表示的字母(包含中文)、数字和空格,以及: _ . : = + - @字符; _sys_开头属于系统标签,租户不能输入。 标签值:支持可用UTF-8格式表示的字母(包含中文)、数字和空格,以及: _ . : = + - @字符。 如您的组织已经设定API网关服务的相关标签策
创建签名密钥 功能介绍 为了保护API的安全性,建议租户为API的访问提供一套保护机制,即租户开放的API,需要对请求来源进行认证,不符合认证的请求直接拒绝访问。 其中,签名密钥就是API安全保护机制的一种。 租户创建一个签名密钥,并将签名密钥与API进行绑定,则API网关在请求
将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。 用户可以定义不同的环境变量,用户在定义API时,在API的定义中使用这些变量,当调用API时,API网关会将这些变量替换成真实的变量值,以达到不同环境的区分效果。 环境
variable_name String 变量名,支持英文字母、数字、英文格式的下划线、中划线,必须以英文字母开头,3~32个字符。在API定义中等于#Name的值#部分(区分大小写),发布到环境里的API被变量值替换。 说明: 中文字符必须为UTF-8或者unicode编码。 id String
如果您需要把自己的认证系统用于API调用的认证鉴权,可以通过配置API的自定义认证来实现;需要对API进行参数编排,可以通过配置API的参数编排规则来实现;需要自定义API的错误响应信息,可以通过自定义API的错误响应信息来实现。更多API相关操作,请参考管理API。 配置API调用授权(可选)
修改指定环境的信息。其中可修改的属性为:name、remark,其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/envs/{id} URI中的参数说明如下表所示。
每个用户最多创建50个应用(凭据)。包括您自行创建的凭据和在云商店购买API生成的APP。 Q:APP认证的API,怎样实现不同的第三方之间无法知道对方调用情况? 创建多个应用(凭据),并绑定同一个API,分发给不同的第三方不一样的应用(凭据)。 Q:APP认证的API,有没有限制可以给多少个第三方使用?
API分组的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 remark 否 String API分组描述。 长度最大不超过255个字符。 说明: 中文字符必须为UTF-8或者unicode编码。
例信息中获取。 id 是 String 环境的ID,可通过查询环境信息获取该ID 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String 环境的名称 支持英文,数字,下划线,且只能以英文字母开头,3 ~ 64字符。 remark 否 String 描述信息
domain 否 String API的访问域名,未提供时根据mode的取值使用如下默认值: DEVELOPER API分组的子域名 MARKET 云商店为API分组分配的域名 CONSUMER API分组的子域名 path 是 String API的请求路径,需以"/"开头,最大长度1024
单击待添加特殊租户的流控策略的名称,进入流控详情页面。 单击“特殊租户”,进入特殊租户页面。 单击“添加特殊租户”,弹出“添加特殊租户”对话框。 输入如表1所示信息。 图3 添加特殊租户信息 表1 特殊租户信息 信息项 描述 租户ID 2中获取的账号ID或项目ID。 绑定APP认证的API时,租户ID为项目ID。