检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询API概况 功能介绍 查询租户名下的API概况：已发布到RELEASE环境的API个数，未发布到RELEASE环境的API个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/a
查询APP概况 功能介绍 查询租户名下的APP概况：已进行API访问授权的APP个数，未进行API访问授权的APP个数。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/r
绑定域名 功能介绍 用户自定义的域名，需要CNAME到API分组的子域名上才能生效，具体方法请参见增加CNAME类型记录集。 每个API分组下最多可绑定5个域名。绑定域名后，用户可通过自定义域名调用API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
删除API 功能介绍 删除指定的API。 删除API时，会删除该API所有相关的资源信息或绑定关系，如API的发布记录，绑定的后端服务，对APP的授权信息等。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
创建APP 功能介绍 APP即应用，是一个可以访问API的身份标识。将API授权给APP后，APP即可调用API。 创建一个APP。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/apps
授权 功能介绍 APP创建成功后，还不能访问API，如果想要访问某个环境上的API，需要将该API在该环境上授权给APP。授权成功后，APP即可访问该环境上的这个API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法
CONSUMER 调试指定运行环境下的API定义 说明： DEVELOPER模式，接口调用者必须是API拥有者。 MARKET模式，接口调用者必须是API购买者或拥有者。 CONSUMER模式，接口调用者必须有API在指定环境上的授权信息或是API拥有者。 app_key 否 String
查看App Code详情 功能介绍 查看App Code详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps/{app_id}/app-codes/{id}
对象模型 本节介绍APP的对象模型，如下表所示。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 APP对象模型 参数 类型 说明 操作类型 是否必选
重置密钥 功能介绍 重置指定APP的密钥。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI PUT /v1/{project_id}/apigw/instances/{instance_id}/apps/secret/{id}
CONSUMER 调试指定运行环境下的API定义 说明： DEVELOPER模式，接口调用者必须是API拥有者。 MARKET模式，接口调用者必须是API购买者或拥有者。 CONSUMER模式，接口调用者必须有API在指定环境上的授权信息或是API拥有者。 app_key 否 String
对象模型 本节介绍API分组的对象模型，如下表所示。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 分组对象模型 参数名称 数据类型 参数说明 操作类型
对象模型 本节介绍环境变量的对象模型，如下表所示： “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 环境变量对象模型 参数 类型 说明 操作类型 是否必选
新建变量 功能介绍 将API发布到不同的环境后，对于不同的环境，可能会有不同的环境变量，比如，API的服务部署地址，请求的版本号等。 用户可以定义不同的环境变量，用户在定义API时，在API的定义中使用这些变量，当调用API时，API网关会将这些变量替换成真实的变量值，以达到不同环境的区分效果。
修改ACL策略 功能介绍 修改指定的ACL策略，其中可修改的属性为：acl_name、acl_type、acl_value，其它属性不可修改。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTPS请求方法以及URI 请求方法 URI PUT /v1.0/apigw/acls/{id}
解绑域名 功能介绍 如果API分组不再需要绑定某个自定义域名，则可以为此API分组解绑此域名。 URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/api-groups/{
删除App Code 功能介绍 删除App Code，App Code删除后，将无法再通过简易认证访问对应的API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/
响应消息样例： { "name": "test", "type": 1, "version": "V0.0.1", "req_protocol": "HTTPS", "req_method": "GET", "req_uri": "/test/{tenant_id}",
查看APP详情 功能介绍 查看指定APP的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apps/{id} URI中的参数说明如下表所示。 表2 参数说明 名称
对象模型 本节介绍APP与API之间的授权关系的对象模型，如下表所示。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 APP授权关系对象模型 参数
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
