检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
auth_opt参数说明 参数 是否必选 类型 说明 app_code_auth_type 否 String AppCode简易认证类型,仅在auth_type为APP时生效,默认为DISABLE: DISABLE:不开启简易认证 HEADER:开启简易认证且AppCode位置在HEADER 请求消息样例:
删除API分组前,要先下线并删除分组下的所有API。 删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
删除API分组前,要先下线并删除分组下的所有API。 删除时,会一并删除直接或间接关联到该分组下的所有资源,包括独立域名、SSL证书、上架信息等等。并会将外部域名与子域名的绑定关系进行解除(取决于域名cname方式)。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
创建API时,为API调用增加身份认证,如使用IAM认证或API网关提供的APP认证,防止API被恶意调用。 设置访问控制策略 从IP地址(或地址区间)以及账号等不同维度,设置白名单/黑名单。 将API绑定流控策略,通过流控策略保护API。 API网关默认API流量控制为每秒200次,如果您的后端服务不能支撑单个API
获取API的请求信息,包括访问域名、请求协议、请求方法、请求路径以及认证方式等信息。 创建应用 使用APP认证的API,需要在API网关中创建一个应用,以生成应用ID和密钥对(AppKey、AppSecret)。将创建的应用绑定API后,使用APP认证调用API。 获取SDK 可通过SDK对AK/SK生成签名,并调用API。
改。 调用API。 绑定独立域名。 在API分组详情页面单击“分组信息”页签。调试域名仅供开发测试使用,且每天最多访问1000次,因此用户需要绑定独立域名来访问分组内的API。 单击“绑定独立域名”,绑定已注册好的公网域名。绑定域名具体操作请参见绑定域名章节。 复制API的URL到浏览器进行调用。
auth_opt参数说明 参数 是否必选 类型 说明 app_code_auth_type 否 String AppCode简易认证类型,仅在auth_type为APP时生效,默认为DISABLE: DISABLE:不开启简易认证 HEADER:开启简易认证且AppCode位置在HEADER 请求消息样例:
删除SSL证书 功能介绍 删除ssl证书接口,删除时只有没有关联域名的证书才能被删除。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/certificates/{certificate_id} 表1 路径参数 参数 是否必选
API调用授权概述 使用APP认证方式的API,需要配置调用授权,把API授权给指定凭据。API调用者在调用API时,可以通过凭据的Key和Secret进行安全认证,也可以通过AppCode进行简易认证。 配置APIG的API认证凭据 在API网关中创建一个凭据,生成密钥对(Ke
包括创建、修改、删除特殊流控策略,查看特殊设置列表。 APP授权管理 包括APP授权、解除授权,查看APP已绑定/未绑定的API列表,查看API已绑定的APP列表。 概要查询 包括查询API概况、API分组概况、APP概况。 域名管理 包括域名的绑定、修改、解绑。域名证书的绑定、删除、查看。 ACL策略管理
String 注册时间 status Integer 状态 1: 有效 app_type String APP的类型: apig:存量apig应用,不推荐使用 roma:roma集成应用 默认apig,暂不支持其他类型 roma_app_type String ROMA_APP的类型:
deleteEnvVariable 创建应用 App createApp 删除应用 App deleteApp 更新应用 App updateApp 重置签名密钥 App resetAppSecret 客户端绑定API AppAuth grantAuth 客户端解绑API AppAuth relieveAuth
String 分组版本 V1:全局分组 V2:应用级分组 V2暂不支持,默认为V1 roma_app_id String 分组归属的集成应用编号。 分组版本V2时必填。 暂不支持 roma_app_name String 分组归属的集成应用名称 暂不支持 表5 UrlDomain 参数
使用APIG的APP认证和自定义认证实现API的双重认证 方案概述 操作流程 实施步骤 父主题: API认证
方案概述 应用场景 API网关提供了灵活的安全认证方式,用户可以配置自定义认证实现API的双重认证方式。本文以API前端认证使用APP认证和自定义认证(双重认证)结合场景为例,具体说明如何创建使用双重认证的API。 方案优势 在API网关提供的安全认证模式下,用户可根据业务需求,
API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名每天最多可以访问1000次。 共享版中的API,分组子域名可公网访问。 对外开放API时,您需要为API分组绑定您自己的独立域名。 后续操作 API分组创建成功后,您可以为此分组绑定域名,API调用者通过访问独立域名来调用您开放的API。 父主题:
安全配置中的安全认证选择APP认证,并勾选“支持双重认证”,选择上一步创建的自定义认证。 创建凭据 使用APP认证的API,需要在API网关中创建一个凭据,生成凭据ID和密钥对(Key、Secret)。 绑定API 将创建的凭据绑定API后,才可以使用APP认证调用API。 验证 调用API,验证双重认证是否设置成功。
DELETE /v2/{project_id}/apigw/instances/{instance_id}/app-quotas/{app_quota_id}/bound-apps/{app_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
分组自定义响应ID roma_app_id String 集成应用ID 暂不支持 domain_name String API绑定的自定义域名 暂不支持 tag String 标签 待废弃,优先使用tags字段 content_type String 请求内容格式类型: application/json
增加一个ACL策略,策略类型通过字段acl_type来确定(permit或者deny),限制的对象的类型可以为IP或者DOMAIN,这里的DOMAIN对应的acl_value的值为租户名称,而非“www.exampleDomain.com”之类的网络域名。 调用方法 请参见如何调用API。