检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
是 String 后端请求协议定义,支持http、https method 是 String 后端请求方法,支持GET、POST、PUT、DELETE、HEAD、OPTIONS、PATCH、ANY path 是 String 后端请求路径,支持路径变量 timeout 否 Integer
本示例以AK和SK保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。以Linux系统为例在本地将已获取的AK/SK设置为环境变量。 打开终端,输入以下命令打开环境变量配置文件。 vi ~/.bashrc 设置环境变量,保存文件并退出编辑器。
参考“附录 > 实例支持的APIG特性”,如确认实例不存在public_key配置可联系技术工程师开启。 aes类型需要实例升级到对应版本,如果不存在可联系技术工程师升级。 sign_key String 签名密钥的key。 hmac类型的签名密钥key:支持英文,数字,下划线,中划线,且只能以英文字母或数字开头,8
码。 app_key 否 String APP的key 支持英文,数字,“_”,“-”,且只能以英文或数字开头,8 ~ 64个字符。 说明: 只支持部分region自定义。 app_secret 否 String 密钥 支持英文,数字,“_”,“-”,“_”,“!”,“@”,“#”
是 String 后端请求协议定义,支持http、https method 是 String 后端请求方法,支持GET、POST、PUT、DELETE、HEAD、OPTIONS、PATCH、ANY path 是 String 后端请求路径,支持路径变量 timeout 否 Number
是 String 后端请求协议定义,支持http、https method 是 String 后端请求方法,支持GET、POST、PUT、DELETE、HEAD、OPTIONS、PATCH、ANY path 是 String 后端请求路径,支持路径变量 timeout 否 Number
调用API的账号名。仅支持配置账号名,对账号名及账号名下的IAM用户名做限制,不支持配置IAM用户名。 可以配置单账号名或多账号名,多账号名以英文格式下的“,”隔开,账号名支持除英文格式下“,”以外的任意ASCII字符,账号名长度限制在1-64个字符,不支持纯数字。多账号名字符的总长度不超过1024。
选择使用Appkey和AppSecret做签名和校验,也可以选择使用AppCode进行简易认证。 为了确保安全,简易认证仅支持HTTPS方式调用API,不支持HTTP。 每个应用最多可创建5个AppCode。 前提条件 已创建应用。 生成AppCode 进入共享版控制台。 选择“调用API
码。 app_key 否 String APP的key 支持英文,数字,“_”,“-”,且只能以英文或数字开头,8 ~ 64个字符。 说明: 只支持部分region自定义。 app_secret 否 String 密钥 支持英文,数字,“_”,“-”,“_”,“!”,“@”,“#”
sign_key String 签名密钥的key。 hmac类型的签名密钥key:支持英文,数字,下划线,中划线,且只能以英文字母或数字开头,8 ~ 32字符。未填写时后台自动生成。 basic类型的签名密钥key:支持英文,数字,下划线,中划线,且只能以英文字母开头,4 ~ 32字符。未填写时后台自动生成。
sign_key String 签名密钥的key。 hmac类型的签名密钥key:支持英文,数字,下划线,中划线,且只能以英文字母或数字开头,8 ~ 32字符。未填写时后台自动生成。 basic类型的签名密钥key:支持英文,数字,下划线,中划线,且只能以英文字母开头,4 ~ 32字符。未填写时后台自动生成。
中文字符必须为UTF-8或者unicode编码。 app_key 否 String APP的key。支持英文,数字,“_”,“-”,且只能以英文或数字开头,8 ~ 200个字符。 app_secret 否 String 密钥。支持英文,数字,“_”,“-”,“!”,“@”,“#”,“$”,“%”,且只能以英文或数字开头,8
表1 参数说明 参数 是否必选 类型 说明 acl-type 是 String 访问控制行为,支持PERMIT、DENY entity-type 是 String 访问控制对象,仅支持IP value 是 String 访问控制策略值,多个值以“,”间隔 父主题: APIG的API设计文件扩展定义
本示例以AK和SK保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。以Linux系统为例在本地将已获取的AK/SK设置为环境变量。 打开终端,输入以下命令打开环境变量配置文件。 vi ~/.bashrc 设置环境变量,保存文件并退出编辑器。
英文字母、数字、点、中连线组成 必须以英文字母开头,最长32字节 不支持以"X-Apig-"或"X-Sdk-"开头,不区分大小写 不支持取值为"X-Stage",不区分大小写 mode为MARKET或CONSUMER时,不支持取值为"X-Auth-Token"和"Authorization",不区分大小写
英文字母、数字、点、中连线组成 必须以英文字母开头,最长32字节 不支持以"X-Apig-"或"X-Sdk-"开头,不区分大小写 不支持取值为"X-Stage",不区分大小写 mode为MARKET或CONSUMER时,不支持取值为"X-Auth-Token"和"Authorization",不区分大小写
API提供的默认网关响应“default”也可以编辑修改。 您可以新增多个网关响应,支持同一分组下不同API配置不同的网关响应内容。 网关响应所定义的错误类型固定且不可修改,具体见网关错误响应类型说明。 响应内容支持调用API网关运行时变量($context变量),具体见API网关运行时可获取变量。
参数 是否必选 类型 说明 type 是 String 策略条件类型,支持equal、enum、pattern value 是 String 策略条件值 origin 是 String 策略条件输入来源,支持source、request parameter 否 String 策略
name 是 String 签名密钥的名称。 支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3 ~ 64字符。 说明: 中文字符必须为UTF-8或者unicode编码。 sign_key 否 String 签名密钥的key。 支持英文,数字,下划线,中划线,且只能以数字或英文字母开头,8
acl_value 是 String ACL策略值,支持一个或多个值,使用英文半角逗号分隔。 entity_type为IP时,策略值需填写IP地址,最多可支持100个IP地址。 entity_type为DOMAIN时,策略值需填写账号名,账号支持除英文半角逗号以外的任意ASCII字符,账号