检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
req_param_id String 关联的请求参数对象编号 req_param_location String 关联的请求参数对象位置 表13 auth_opt参数说明 参数 类型 说明 app_code_auth_type String AppCode简易认证类型 响应消息样例
设置基本信息 进入共享版控制台。 单击“开放API > API管理”,进入到API列表信息页面。 单击“新建API”,进入“新建API”页面。填写如表1所示信息。 图1 基本信息 表1 基本信息 信息项 描述 API名称 API名称,根据规划自定义。
授权项变更公告 公告说明 自2024年9月起,当用户使用以下API的自定义策略授权时,用户需创建或更新自定义策略才可访问。 权限描述 对应的API 新增授权项 依赖授权项 IAM项目(Project) 企业项目(Enterprise Project) 获取SSL证书列表 GET /
响应消息 表3 参数说明 名称 类型 说明 id String 编号 acl_name String 名称 acl_type String 类型 PERMIT(白名单类型) DENY(黑名单类型) acl_value String ACL策略的值 entity_type String 对象类型
前端配置 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称。 在“API运行”页面,单击“创建API > 创建API”。 根据下表参数信息,配置前端定义。
表5 后端实例详情 名称 类型 说明 id String 后端实例对象的编号。 vpc_id String VPC通道的编号。 status Integer 后端实例对象的状态。 instance_name String 后端实例的名称。
基本概念 API API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,应用将自身的服务能力封装成API,并通过API网关开放给用户调用。 API包括基本信息、前后端的请求路径和参数以及请求相关协议。 API分组 API
配置管理 包括配置对象模型和查询租户配置详情接口。 概要查询 包括概要信息的查询接口。 签名密钥管理 包括签名密钥的创建、修改、删除和查询接口。 签名密钥绑定关系管理 包括签名密钥的绑定和解除绑定接口,查询签名密钥绑定/未绑定API列表接口。
String ACL策略编号 acl_name String ACL策略名称 acl_type String ACL策略类型 PERMIT (白名单类型) DENY (黑名单类型) acl_value String ACL策略值 entity_type String ACL策略作用的对象类型
req_param_id String 关联的请求参数对象编号 req_param_location String 关联的请求参数对象位置 表24 auth_opt参数说明 参数 类型 说明 app_code_auth_type String AppCode简易认证类型 响应消息样例
req_param_id String 关联的请求参数对象编号 req_param_location String 关联的请求参数对象位置 表25 auth_opt参数说明 参数 类型 说明 app_code_auth_type String AppCode简易认证类型 响应消息样例
String API访问协议 req_method String API请求方式 req_uri String API访问地址 auth_type String API认证方式 auth_opt 字段数据类型 API认证方式参数 authorizer_id String 前端自定义认证对象的
instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。
instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。
lock_scene String 限制操作场景: TO_PERIOD_LOCK:按需转包周期场景锁,不允许进行删除、规格变更、按需转包周期等 SPEC_CHG_LOCK:包周期规格变更场景锁,不允许进行删除、规格变更等 lock_source_id String 发起限制操作对象的标志
“context”字段为可选,支持字符串类型键值对,当实例支持authorizer_context_support_num_bool特性时,键值对的值支持number类型和boolean类型,键值不支持JSON对象或数组。
“context”字段为可选,支持字符串类型键值对,当实例支持authorizer_context_support_num_bool特性时,键值对的值支持number类型或boolean类型,键值不支持JSON对象或数组。
String API访问协议 req_method String API请求方式 req_uri String API访问地址 auth_type String API认证方式 auth_opt 字段数据类型 API认证方式参数 authorizer_id String 前端自定义认证对象的
入门实践 您可以根据自身的业务需求使用APIG提供的一系列常用实践。 表1 常用最佳实践 实践 描述 使用函数服务开发自定义认证 在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证
String API访问协议 req_method String API请求方式 req_uri String API访问地址 auth_type String API认证方式 auth_opt 字段数据类型 API认证方式参数 authorizer_id String 前端自定义认证对象的