检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API调用授权概述 API调用者在调用使用APP认证方式的API时,可以通过用凭据进行API认证或AppCode进行简易的API认证。您可以根据业务需求选择其中一种进行认证,下文介绍具体两种认证方式的配置。 配置APIG的API认证凭据 在API网关中创建一个凭据,生成密钥对(Key
管理API概述 API创建完成后,您还可以进行以下相关操作管理API。 查看或编辑APIG的API信息:您可以通过查看API的基本信息来确认API的调用信息,通过编辑API的基本信息来更改服务信息。 配置API的自定义认证:您可以通过自定义认证来自定义认证系统。 配置API的参数编排规则
创建签名密钥 功能介绍 为了保护API的安全性,建议租户为API的访问提供一套保护机制,即租户开放的API,需要对请求来源进行认证,不符合认证的请求直接拒绝访问。 其中,签名密钥就是API安全保护机制的一种。 租户创建一个签名密钥,并将签名密钥与API进行绑定,则API网关在请求这个
调用API报“Incorrect IAM authentication information” IAM认证信息错误有: Incorrect IAM authentication information: verify aksk signature fail Incorrect IAM
x-apigateway-backend-policies 含义:API网关定义的API后端策略。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/users/{userId}': get:
包年/包月 包年/包月是一种先付费再使用的计费模式,适用于对资源需求稳定且希望降低成本的用户。通过选择包年/包月的计费模式,您可以预先购买专享版API网关并获得一定程度的价格优惠。下面介绍包年/包月API网关的计费规则。 适用场景 包年/包月计费模式需要用户预先支付一定时长的费用,
计费模式概述 专享版API网关 专享版API网关按实例版本费用+公网带宽费用计费。计费模式详情请参考表表1和表2。 实例版本详情请参考产品规格,实例版本价格详情请参考价格详情,每种实例版本提供包年/包月、按需计费两种计费模式,以满足不同场景下的用户需求。 包年/包月:一种预付费模式
修改流控策略 功能介绍 修改指定流控策略的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/throttles/{id} URI中的参数说明如下表所示。 表2 参数说明
查看版本详情 功能介绍 查询某个指定的版本详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apis/versions/{version_id} URI中的参数说明如下表所示
查看API详情 功能介绍 查看指定的API的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apis/{id} URI中的参数说明如下表所示。 表2 参数说明 名称
查询项目下所有实例标签 功能介绍 查询项目下所有实例标签。 接口约束 使用策略授权用户时,需要包含apig:instanceTags:list的授权项才允许调用此接口 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instance-tags
删除SSL证书 功能介绍 删除ssl证书接口,删除时只有没有关联域名的证书才能被删除。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/certificates/{certificate_id} 表1 路径参数 参数 是否必选
查看分组详情 功能介绍 查询指定分组的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/api-groups/{id} URI中的参数说明如下表所示。 表2 参数说明
错误码 当调用API时,可能遇到如表1所示的错误码。如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 通过APIG接口管理API,发生错误时,产生的错误码请参考错误码。 使用APIG错误码时,请以错误码(如APIG.0101)为准,错误信息并非固定不变,有时会对错误信息进行优化修改
SSL证书绑定域名 功能介绍 SSL证书绑定域名。使用实例自定义入方向端口的特性时,相同的域名会同时绑定证书,注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/certificates
查询租户实例配置列表 功能介绍 查询租户实例配置列表 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instance/configs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,
修改API分组 功能介绍 修改API分组属性。其中name和remark可修改,其他属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/api-groups/{id
SSL证书解绑域名 功能介绍 SSL证书解绑域名。在使用自定义入方向端口的特性时,相同的域名会同时解绑证书。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/certificates/{certificate_id}/domains
查看证书详情 功能介绍 查看证书详情。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/certificates/{certificate_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查询包含指定标签的实例数量 功能介绍 查询包含指定标签的实例数量。 接口约束 使用策略授权用户时,需要包含apig:instance:getNumByTags的授权项才允许调用此接口。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw