检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
开放API 无法创建API是什么原因? API的响应码如何定义? API的后端服务是否支持绑定私网ELB地址? API的后端服务地址支持填写私有地址(子网IP)吗? APIG是否支持多后端节点方案? API可以绑定内网域名吗? 为什么跨域调用API失败? API网关如何开放部署在华为云上的服务?
PERMIT (白名单类型) DENY (黑名单类型) app_acl_values 是 Array of strings ACL策略值,支持IP、IP范围和CIDR方式。IP范围以英文中划线分隔。 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 app_id
n的值)。 响应参数 状态码: 201 表3 响应Body参数 参数 参数类型 描述 app_code String App Code值 支持英文、数字,+_!@#$%-/=,且只能以英文、数字和+、/开头,64-180个字符。 id String 编号 app_id String
n的值)。 响应参数 状态码: 201 表3 响应Body参数 参数 参数类型 描述 app_code String App Code值 支持英文、数字,+_!@#$%-/=,且只能以英文、数字和+、/开头,64-180个字符。 id String 编号 app_id String
中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 环境的名称,支持英文,数字,下划线,且只能以英文字母开头。 最小长度:3 最大长度:64 remark 否 String 描述信息 说明: 中文字符必须为UTF-8或者unicode编码。
arrange_necessary Integer 是否需要编排 tag String 服务名称标签,待废弃字段 tags []String 标签 cors Bool 是否支持跨域访问 body_remark String API请求体描述,可以是请求体示例、媒体类型、参数等信息 result_normal_sample
码。 app_key 否 String APP的key 支持英文,数字,“_”,“-”,且只能以英文或数字开头,8 ~ 64个字符。 说明: 只支持部分region自定义。 app_secret 否 String 密钥 支持英文,数字,“_”,“-”,“_”,“!”,“@”,“#”
用Key和Secret做签名和校验,也可以选择使用AppCode进行简易认证。 约束与限制 为了确保安全,简易认证仅支持HTTPS或GRPCS方式调用API,不支持HTTP。 每个凭据最多可创建5个AppCode。 生成AppCode 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。
流量控制2.0策略可以限制单位时间内API的被调用次数,支持基础流控、参数流控和基于基础流控的特殊流控。 基础流控:可以对API、用户、凭据、源IP进行多维度流控,与已有的流量控制策略说明功能一致,但配置方式不兼容。 参数流控:支持根据Header、Path、Method、Query以及系统变量中的参数值进行自定义流控。
配置凭据配额策略 参数 说明 策略名称 填写客户端配额策略的名称,根据业务规划自定义。建议您按照一定的命名规则填写配额策略名称,方便您快速识别和查找。 支持中文、英文、数字、下划线,且只能以英文或中文开头,长度为3~255个字符。 首次生效时间点 设置配额策略的生效起始时间点。例如,时长为1小
AM用户名做限制,不支持配置IAM用户名。 可以配置单账号名或多账号名,多账号名以英文格式下的逗号“,”隔开,账号名支持除英文格式下“,”以外的任意ASCII字符,账号名长度限制在1~64个字符,不支持纯数字。多账号名字符的总长度不超过1024。 账号ID:仅适用IAM认证类型的
bind_num Integer 流控策略绑定的API数量 enable_adaptive_control String 是否开启动态流控,暂不支持 响应消息样例: { "total": 1, "size": 1, "throttles": [{ "id": "0325b67
arrange_necessary Integer 是否需要编排 tag String 服务名称标签,待废弃字段 tags []String 标签 cors Bool 是否支持跨域访问 body_remark String API请求体描述,可以是请求体示例、媒体类型、参数等信息 result_normal_sample
选择使用Appkey和AppSecret做签名和校验,也可以选择使用AppCode进行简易认证。 为了确保安全,简易认证仅支持HTTPS方式调用API,不支持HTTP。 每个应用最多可创建5个AppCode。 前提条件 已创建应用。 生成AppCode 进入共享版控制台。 选择“调用API
api_remark String API描述 sign_id String 签名密钥的编号 sign_name String 签名密钥的名称。支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3 ~ 64字符。 说明: 中文字符必须为UTF-8或者unicode编码。 req_method
码。 app_key 否 String APP的key 支持英文,数字,“_”,“-”,且只能以英文或数字开头,8 ~ 64个字符。 说明: 只支持部分region自定义。 app_secret 否 String 密钥 支持英文,数字,“_”,“-”,“_”,“!”,“@”,“#”
publish_id String 发布记录的编号 tag String 服务名称标签,待废弃字段 tags []String 标签 cors Bool 是否支持跨域访问 body_remark String API请求体描述,可以是请求体示例、媒体类型、参数等信息 result_normal_sample
publish_id String 发布记录的编号 tag String 服务名称标签,待废弃字段 tags []String 标签 cors Bool 是否支持跨域访问 body_remark String API请求体描述,可以是请求体示例、媒体类型、参数等信息 result_normal_sample
bind_num Integer 流控策略绑定的API数量 enable_adaptive_control String 是否开启动态流控,暂不支持 响应消息样例: { "total": 1, "size": 1, "throttles": [{ "id": "0325b67
表1 参数说明 参数 是否必选 类型 说明 acl-type 是 String 访问控制行为,支持PERMIT、DENY。 entity-type 是 String 访问控制对象,仅支持IP。 value 是 String 访问控制策略值,多个值以“,”间隔。 父主题: APIG的API设计文件扩展定义