检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API网关如何开放部署在华为云上的服务? 如果部署在华为云上的服务绑定了公网IP地址,在API网关中创建API时,使用公网IP地址:端口号作为后端服务地址。如果此服务已绑定域名,则优先使用域名作为后端服务地址。创建API的详细步骤请参见创建API。 如果部署在华为云上的服务无公网IP
访问控制主要用于禁止或仅允许某些账号/源访问IP的API调用。 此部分操作在API网关服务中完成,您可以参考访问控制章节。 在华为云商店中,入住卖家中心,将您的API开放售卖。 将API上架到华为云商店售卖。 此部分操作在华为云商店完成,您需要作为卖家入驻云商店,然后发布API商品。 专享版实例暂不支持将API上架到云商店公开售卖。
OpenAPI接口 导出分组下所有API 批量导出API 导入API到新分组 导入API到已有分组 父主题: 共享版API(仅存量用户使用)
x-apigateway-content-type 含义: API的请求内容类型。 作用域: Operation Object(2.0) 示例: paths: /: get: x-apigateway-content-type: application/json
x-apigateway-authorizer 含义:自定义认证对象。 作用域: Security Scheme Object 示例: x-apigateway-authorizer: auth_downgrade_enabled: false authorizer_alias_uri:
x-apigateway-result-failure-sample 含义:失败响应示例。 作用域: Operation Responses 示例: paths: /: get: responses: default:
配置API的自定义认证 配置API的前端自定义认证 配置API的后端自定义认证 父主题: 管理API
x-apigateway-access-control 含义:引用访问控制策略。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: x-apigateway-access-control:
x-apigateway-backend.parameters 含义:API网关定义的API后端参数定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get: produces:
x-apigateway-access-controls 含义:访问控制策略名称与关联策略映射。 作用域:Swagger Object 示例: x-apigateway-access-controls: customAccessControlName: acl-type:
x-apigateway-result-normal-sample 含义:成功响应示例。 作用域: Operation Responses 示例: paths: /: get: responses: default: x
x-apigateway-response 含义:API的网关响应名称。 作用域: Operation Object(2.0)/Operation Object(3.0) 示例: paths: /: get: x-apigateway-response: test
x-apigateway-responses 含义:自定义网关响应类型。 作用域: Operation Object(2.0)/Operation Object(3.0) 示例: x-apigateway-responses: default: ACCESS_DENIED:
x-apigateway-ratelimit 含义:引用流控策略。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: x-apigateway-ratelimit:
x-apigateway-access-controls.policy 含义:访问控制策略定义。 作用域:x-apigateway-access-controls 示例: x-apigateway-access-controls: customAccessControlName:
x-apigateway-sample 含义: API的请求参数示例值。 作用域: Operation Object(2.0)/Operation Object(3.0) 示例: paths: /: get: parameters: - maximum:
x-apigateway-ratelimits 含义:流控策略名称与关联策略映射。 作用域:Swagger Object 示例: x-apigateway-ratelimits: customRatelimitName: api-limit: 200 app-limit:
x-apigateway-backend-policies 含义:API网关定义的API后端策略。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/users/{userId}': get:
x-apigateway-ratelimits.policy 含义:流控策略定义。 作用域:x-apigateway-ratelimits 示例: x-apigateway-ratelimits: customRatelimitName: api-limit: 200
x-apigateway-ratelimits.policy.special 含义:特殊流控策略定义。 作用域:x-apigateway-ratelimits.policy 示例: x-apigateway-ratelimits: customRatelimitName: