检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查看App Code详情 功能介绍 查看App Code详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps/{app_id}/app-codes/{id}
自动生成App Code 功能介绍 创建App Code时,可以不指定具体值,由后台自动生成随机字符串填充。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/apps/{app_id}/app-codes
类型 PERMIT (白名单类型) DENY (黑名单类型) app_acl_values Array of strings ACL策略值,支持IP、IP范围和CIDR方式。IP范围以英文中划线分隔。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code
创建API 创建GRPC API 克隆API 开启跨域访问 调试API 授权API 发布API 下线API 导入导出API 查看API列表 支持HTTP2.0
参数 是否必选 类型 说明 app_secret 否 String 密钥 支持英文,数字,“_”,“-”,“_”,“!”,“@”,“#”,“$”,“%”,且只能以英文或数字开头,8 ~ 64个字符。 说明: 只支持部分region自定义。 请求消息样例: { "app_secret":
s apig:certificate:create apig:instances:get √ 请求参数中携带instance_id时支持,否则不支持 删除SSL证书 DELETE /v2/{project_id}/apigw/certificates/{certificate_id}
API管理 流量控制 访问控制 环境管理 签名密钥 VPC通道 自定义认证 监控 应用管理 SDK 已购买API 调用已发布的API 云审计服务支持的关键操作
instance: xxxxxxxx 表1 参数说明 参数 是否必选 类型 说明 type 是 String 特殊流控策略类型,支持APP、USER limit 是 Number 访问次数 instance 是 String 特殊APP或USER的对象标识 父主题: 扩展定义
String 作用的对象类型: IP DOMAIN precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token
当用户使用gRPC服务时,可以通过API网关创建API,实现gRPC服务的路由转发。 约束与限制 由于GRPCS协议的约束,gRPC类型的API不支持导入、导出、调试。 父主题: 基于API网关专享版实现gRPC服务的路由转发
输入需要允许或者禁止访问API的IAM账号,仅适用于API的安全认证方式为IAM认证时。 仅在“限制类型”为“账号名”时,需要设置。支持输入多个账户名,以英文“,”隔开,如aaa,bbb。 说明: 仅支持IAM账号维度的访问控制,不能对单个IAM用户进行访问控制。 单击“确定”,完成访问控制策略的创建。您可
者与已开启CORS的API匹配的请求路径。 匹配模式:选择前缀匹配。 安全认证:“无认证”模式安全级别低,所有用户均可访问,不推荐使用。 支持跨域CORS:勾选。 父主题: API创建
Number 源IP访问次数限制 interval 是 Number 流控策略时间周期 unit 是 String 流控策略时间周期单位,支持SECOND、MINUTE、HOUR、DAY shared 否 Boolean 是否共享流控策略 special 否 x-apigateway-ratelimits
Boolean 是否为默认响应 表5 ResponseInfoHeader 参数 参数类型 描述 key String 分组自定义响应的响应头的key,支持英文字母、数字和中划线,长度为1到128位 value String 分组自定义响应的响应头的value,为长度为1到1024位的字符串 最小长度:1
例如访问名为“DEVELOP”的环境,则添加“X-Stage:DEVELOP”。 API网关管理控制台的“调试”功能,固定为调试环境,不支持携带环境变量调试。 后续操作 创建完环境后,您可以将API发布到环境,以便API调用者调用。 父主题: API策略
page_no 否 Integer 页码,默认值:1 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的流控策略的数量 size Integer 本次返回的列表长度
page_no 否 Integer 页码,默认值:1 precise_search 否 String 指定需要精确匹配查找的参数名称,目前仅支持name 响应消息 表3 参数说明 名称 类型 说明 total Integer 符合条件的流控策略的数量 size Integer 本次返回的列表长度
在华为云商店中,入住卖家中心,将您的API开放售卖。 将API上架到华为云商店售卖。 此部分操作在华为云商店完成,您需要作为卖家入驻云商店,然后发布API商品。 专享版实例暂不支持将API上架到云商店公开售卖。 父主题: 其他
String 环境的ID,可通过查询环境信息获取该ID 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String 环境的名称 支持英文,数字,下划线,且只能以英文字母开头,3 ~ 64字符。 remark 否 String 描述信息 字符长度不能大于255。 说明:
curl 操作场景 使用curl命令调用APP认证的API时,您需要先下载JavaScript SDK生成curl命令,然后将curl命令复制到命令行调用API。 前提条件 已获取API的调用信息,具体参见认证前准备。 调用API示例 使用JavaScript SDK生成curl命令。