检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API发布到不同环境后,会调用不同的后端服务吗? 使用环境变量,或者在后端服务定义不同的参数,可以实现API发布到不同环境后,调用不同的后端服务。 有关环境变量的详细指导,请参考创建环境变量。 父主题: 发布API
String 认证类型,仅支持apiKey。 name 是 String 用于认证的参数名称。 in 是 String 仅支持header。 description 否 String 描述信息。 父主题: APIG的API设计文件扩展定义
删除APP Code 功能介绍 删除App Code,App Code删除后,将无法再通过简易认证访问对应的API。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{
删除凭据配额 功能介绍 删除凭据配额。删除凭据配额时,同时删除凭据配额和凭据的关联关系 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/app-quotas/{app_quota_id}
删除ACL策略 功能介绍 删除指定的ACL策略, 如果存在api与该ACL策略的绑定关系,则无法删除 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/acls/{acl_id} 表1
URI中的参数说明如下表所示。 表2 参数说明 参数 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。
项目ID。可从控制台“我的凭证”中获取region下项目ID,管理员权限可查询。 instance_id 是 String 实例ID,可从API网关控制台的专享版实例信息中获取。 env_id/env 是 String API分组发布的环境ID,目前支持env_id和env,两个均存在时以env_id为准,建议使用env_id
实例配置特性 功能介绍 为实例配置需要的特性。 支持配置的特性列表及特性配置示例请参考本手册中的“附录 > 实例支持的APIG特性”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/features
删除插件 功能介绍 删除插件。 必须先解除API和插件的绑定关系,否则删除报错 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id} 表1 路径参数
对精细化授权的要求,无法完全达到企业对权限最小化的安全管控要求。 策略:IAM最新提供的一种细粒度授权的能力,可以精确到具体服务的操作、资源以及请求条件等。基于策略的授权是一种更加灵活的授权方式,能够满足企业对权限最小化的安全管控要求。例如:针对API网关服务,管理员能够控制IA
entity-type: "IP" value: 127.0.0.1,192.168.0.1/16 表1 参数说明 参数 是否必选 类型 说明 customAccessControlName 否 x-apigateway-access-controls.policy 指定名称的访问控制策略。
解除授权 功能介绍 解除API对APP的授权关系。解除授权后,APP将不再能够调用该API。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/app-auths/{app_auth_id}
删除签名密钥 功能介绍 删除指定的签名密钥,删除签名密钥时,其配置的绑定关系会一并删除,相应的签名密钥会失效。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/signs/{sign_id}
x-apigateway-backend-policies 含义:API网关定义的API后端策略。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/users/{userId}': get:
ingress_https_port 否 Integer 访问该域名绑定的https协议入方向端口,-1表示无端口且协议不支持,可使用443默认端口,其他有效端口允许的取值范围为1024~49151,需为实例已开放的HTTPS协议的自定义入方向端口。 当创建域名时,该参数未填表示用默认443
version_id String 在线的版本号 表7 BatchFailure 参数 参数类型 描述 api_id String 发布或下线失败的API ID api_name String 发布或下线失败的APi名称 error_code String 发布或下线失败的错误码 error_msg
Key唯一且不可重置,Secret支持重置,将Secret的值重新改变。重置完成后,原先的Secret将失效,绑定此凭据的API将无法调用,请更新SDK中的密钥对,并重新调用API。 在左侧导航栏选择“API管理 > 凭据管理”。 单击凭据名称,进入凭据详情页面。 单击“重置Secret”。
功能介绍 校验app是否存在,非APP所有者可以调用该接口校验APP是否真实存在。这个接口只展示app的基本信息id 、name、 remark,其他信息不显示。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{i
instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 group_id 是 String 分组的编号 domain_id 是 String 域名的编号 certificate_id 是 String 证书的编号 请求参数 表2 请求Header参数 参数 是否必选
设置调试域名是否可以访问 功能介绍 禁用或启用API分组绑定的调试域名 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/sl-domain-access-settings