检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
绑定域名 功能介绍 用户自定义的域名,需要CNAME到API分组的子域名上才能生效,具体方法请参见增加A类型记录集。 每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
删除API 操作场景 已发布的API不再提供服务,可以将API删除。 该操作将导致此API无法被访问,可能会影响正在使用此API的应用或者用户,请确保已经告知用户。 已上架云商店的API,无法被删除。 已发布的API,需要先下线API,再删除。 操作步骤 进入共享版控制台。 单击“开放API
是否已上架云商店: 1:已上架 2:未上架 3:审核中 call_limits Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置 time_interval Integer 流控时长 time_unit String 流控的时间单位 url_domains
专享版-域名管理 绑定域名 绑定域名证书 修改域名 解绑域名 设置调试域名是否可以访问 删除域名证书 查看域名证书 父主题: 专享版API(V2)
instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
0303", "request_id": "fd65***b8ad" } 可能原因 客户端签名时间戳x-sdk-date与APIGW服务器时间相差超过15min。 解决方法 检查客户端时间是否正确。 父主题: 调用API
已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入共享版控制台。 单击“开放API >
VPC通道的创建时间。 表5 后端实例详情 名称 类型 说明 id String 后端实例对象的编号。 vpc_id String VPC通道的编号。 status Integer 后端实例对象的状态。 instance_name String 后端实例的名称。 instance_id
VPC通道的成员类型。 ip(暂不支持) instance status Integer VPC通道的状态。 1:正常 2:异常 port Integer VPC通道中主机的端口号。 balance_strategy Integer 分发算法。 1:加权轮询(wrr) 2:加权最少连接(wleastconn)
创建APP 功能介绍 APP即应用,是一个可以访问API的身份标识。将API授权给APP后,APP即可调用API。 创建一个APP。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/apps
自动续费可以减少手动续费的管理成本,避免因忘记手动续费而导致实例被自动删除。自动续费的规则如下所述: 以实例的到期日计算第一次自动续费日期和计费周期。 实例自动续费周期以您选择的续费时长为准。例如,您选择了3个月,实例即在每次到期前自动续费3个月。 在实例到期前均可开通自动续费,到期前7日凌晨3:
删除环境 功能介绍 删除指定的环境。 该操作将导致此API在指定的环境无法被访问,可能会影响相当一部分应用和用户。请确保已经告知用户,或者确认需要强制下线。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
认证类型,仅支持apiKey。 name 是 String 用于认证的参数名称。 in 是 String 仅支持header。 description 否 String 描述信息。 父主题: APIG的API设计文件扩展定义
- "application/json" responses: default: description: "default response" x-apigateway-request-type: "public"
- "application/json" responses: default: description: "default response" x-apigateway-request-type: "public"
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String APP的名称 支持汉字,
数据保护技术 安全通道:APIG支持HTTPs协议,保证网络传输安全,同时支持创建安全通道访问后端服务。 防重放、防篡改:APIG通过内部算法,从数据入口屏蔽恶意调用。 父主题: 安全
API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名每天最多可以访问1000次。 共享版中的API,分组子域名可公网访问。 对外开放API时,您需要为API分组绑定您自己的独立域名。 后续操作 API分组创建成功后,您可以为此分组绑定域名,API调用者通过访问独立域名来调用您开放的API。 父主题: API分组管理
手动续费 包年/包月实例从购买到被自动删除之前,您可以随时在控制台为实例续费,以延长实例的使用时间。 前提条件 请确认包年/包月实例还未到期。 操作步骤 方式一:在API网关控制台的实例管理中续费。 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在待续费的实例上单击“更多 >
API的版本 CRU 否 req_protocol String API的访问协议 HTTP HTTPS BOTH:同时支持HTTP和HTTPS 默认:HTTPS CRU 否 req_method String API的访问方式 GET POST PUT DELETE HEAD PATCH