检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
删除指定的API分组。 删除API分组前,要先下线并删除分组下的所有API。 删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。 URI HTTP/HTTPS请求方法以及URI如下表所示。
删除指定的API分组。 删除API分组前,要先下线并删除分组下的所有API。 删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书、上架信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。 URI HTTP/HTTPS请求方法以及URI如下表所示。
String API分组的名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以英文或中文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 remark 否 String API分组描述。 长度最大不超过255个字符。 说明: 中
name 是 String 名称。 长度为3 ~ 64位的字符串,字符串由中文、英文字母、数字、“_”组成,且只能以中文或英文开头。 说明: 中文字符必须为UTF-8或者unicode编码。 remark 否 String 描述。 字符串长度最大不超过255。 说明: 中文字符必须为UTF-8或者unicode编码。
keys are not supported. 不支持加密的私钥 使用没有加密的私钥 400 APIG.2106 Invalid certificate or private key. 无效的证书或私钥 使用正确的证书和私钥 400 APIG.2108 Microservice unavailable
双向认证 API前端定义中的请求协议支持HTTPS时,API所属分组在绑定独立域名后,还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书,当SSL证书带有CA证书时,默认开启客户端认证即双向认证;反之,开启单向认证。 使用APIG专享版实现不同后端服务的调用
参数说明 名称 类型 说明 total Integer 满足条件的分组总数 size Integer 本次返回的列表长度 groups 字典数据类型 分组列表 表4 字典数据类型:分组字段说明 名称 类型 说明 id String 编号 name String 名称 status Integer
Integer 域名cname状态: 1:未解析 2:解析中 3:解析成功 4:解析失败 ssl_id String SSL证书编号 ssl_name String SSL证书名称 响应消息样例: { "id": "7efb2b91-155a-4f6a-9f45-c5c95a6e4950"
头。 最小长度:1 最大长度:32 remark String 描述。字符长度不超过255 说明: 中文字符必须为UTF-8或者unicode编码。 location String 参数位置:PATH、QUERY、HEADER value String 参数值。字符长度不超过255
头。 最小长度:1 最大长度:32 remark String 描述。字符长度不超过255 说明: 中文字符必须为UTF-8或者unicode编码。 location String 参数位置:PATH、QUERY、HEADER value String 参数值。字符长度不超过255
IAM项目(Project) 企业项目(Enterprise Project) 获取SSL证书列表 GET /v2/{project_id}/apigw/certificates apig:certificate:list - √ √ 创建SSL证书 POST /v2/{project_id}/apigw/certificates
自定义认证:APIG支持用户以函数自定义API认证方式,丰富鉴权逻辑。 证书校验:APIG支持对后端服务进行证书校验。 身份认证:APIG提供签名密钥进行后端访问身份认证。 访问控制 流量控制:APIG通过凭据、API、IP、用户等多维度的流控策略保护系统。 黑白名单:APIG支持系统级
头。 最小长度:1 最大长度:32 remark String 描述。字符长度不超过255 说明: 中文字符必须为UTF-8或者unicode编码。 location String 参数位置:PATH、QUERY、HEADER value String 参数值。字符长度不超过255
开放API 开放API流程 创建API分组 添加API的SSL证书 配置API的调用域名 创建API的负载通道(可选) 创建API 调试APIG创建的API 配置API的发布环境和环境变量(可选) 发布APIG创建的API
ssl_infos Array of SslInfo objects SSL证书列表。 表5 SslInfo 参数 参数类型 描述 ssl_id String SSL证书编号。 ssl_name String SSL证书名称。 algorithm_type String 证书算法类型:
APP认证(签名认证)在对API请求进行加密签名时,需要用到API所授权凭据的Key和Secret。在APIG实例控制台选择“API管理 > 凭据管理”,进入凭据详情,获取Key和Secret。 AppKey/Key:APP访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。
证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。 约束与限制:
编排后的参数配置,isPreprocessing为false时必填。 is_preprocessing Boolean 是否为预处理策略,预处理策略只会生成临时参数作为后面参数编排规则的入参标记。当为预处理策略时,该编排规则不能作为除default之外的最后一个编排规则。 orchestration_id String
将一个API授权给多个应用,也可以将多个API授权给同一个应用。 签名密钥 签名密钥由一对Key和Secret组成,用于后端服务验证API网关的身份,在API网关请求后端服务时,保障后端服务的安全。 当签名密钥绑定API后,API网关向后端服务发送此API的请求时,会增加相应的签
回全量数据。 数组长度:0 - 20 sys_tags 否 Array of TmsKeyValues objects 企业项目.仅op_service权限可以使用此字段做资源实例过滤条件. 无sys_tags时按照tag接口处理,无tag过滤条件时返回全量数据。 数组长度:0 -