检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
x-apigateway-auth-opt 含义:APP简易认证方式参数。 作用域:Security Scheme Object(2.0)/Security Scheme Object(3.0) Swagger示例: securityDefinitions: apig-auth-app:
x-apigateway-pass-through 含义:API的请求参数是否透传。always为是,never为否。 作用域: Operation Object(2.0)/Operation Object(3.0) 示例: paths: /: get: parameters:
对象模型 本节介绍签名密钥的对象模型,如下表所示: “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 签名密钥模型 参数 类型 说明 操作类型 是否必选
签名密钥绑定关系管理(待下线) 对象模型 查看签名密钥未绑定的API列表 绑定签名密钥 查看签名密钥绑定的API列表 查看API绑定的签名密钥列表 解除绑定 父主题: 专享版API(V1)(待下线)
API的后端服务报“Backend domain name resolution failed” APIG实例所在的VPC完成了内网域名解析,后端服务调用仍报“域名无法解析”错误。 可能原因 APIG实例所在的VPC与用户后端服务所在的VPC存在网络隔离,内网域名解析仅在用户后端服务所在的VPC下能够解析。
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 api_id 是 String API编号 表2 Query参数 参数 是否必选 参数类型 描述 offset
添加后端实例(云服务器) 功能介绍 为指定的VPC通道添加云服务器。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/vpc-channels/{id}/members URI中的参数说明如下表所示。
SSL证书解绑域名 功能介绍 SSL证书解绑域名。在使用自定义入方向端口的特性时,相同的域名会同时解绑证书。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/certificates/{certificate_id}/domains/detach
格式表示的字母(包含中文)、数字和空格,以及以下字符: _ . : = + - @; _sys_开头属于系统标签,租户不能输入 最小长度:1 最大长度:128 values Array of strings 值。 支持可用 UTF-8 格式表示的字母(包含中文)、数字和空格,以及以下字符: _
x-apigateway-access-controls 含义:访问控制策略名称与关联策略映射。 作用域:Swagger Object 示例: x-apigateway-access-controls: customAccessControlName: acl-type:
x-apigateway-result-normal-sample 含义:成功响应示例。 作用域: Operation Responses 示例: paths: /: get: responses: default: x
下划线,且只能以英文和汉字开头,1-64字符。 说明: 中文字符必须为UTF-8或者unicode编码。 最小长度:1 最大长度:64 label_key 否 String 服务标识名。支持汉字、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号,且只能以英文、汉字和数字开头,1-64个字符。
es/{instance_id}/apis/publish/{api_id}[?env_id,env_name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:env_id,env_name。 URI中的参数说明如下表所示。 表2 参数说明
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 action 是 String 必须为delete 请求消息 表3 参数说明 参数 是否必选 类型 说明 acls
String 实例ID,可从API网关控制台的专享版实例信息中获取。 id 是 String 签名密钥编号 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String 签名密钥的名称。 支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3 ~ 64字符。 说明:
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 app_quota_id 是 String 凭据配额编号 请求参数 表2 请求Header参数 参数 是否必选
es[?page_size, page_no, env_id, group_id, variable_name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:env_id、group_id、variable_name、page_size、page_no
project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 group_id 是 String 分组的编号 domain_id 是 String 域名的编号 请求参数 表2
s/{instance_id}/throttles[?page_size, page_no, id, name] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值:id、name、page_size、page_no。 请求消息 表2 参数说明