华为云用户手册

响应消息 表3 参数说明 名称 类型 说明 id String 编号 acl_name String 名称 acl_type String 类型 PERMIT（白名单类型） DENY（黑名单类型） acl_value String ACL策略的值 entity_type String 对象类型： IP DOMAIN update_time Timestamp 更新时间 响应消息样例： {"id": "d402b35e-1054-4280-b1c5-0d741a28c995","acl_name": "goodone","entity_type": "DOMAIN","acl_type": "PERMIT","acl_value": "19asdfaf-adfadf","update_time": "2017-11-18T14:27:36.918578+08:00"}

请求消息 表2 参数说明 参数 类型 说明 acl_name String ACL策略名称。 支持汉字，英文，数字，下划线，且只能以英文和汉字开头，3 ~ 64字符。 说明： 中文字符必须为UTF-8或者unicode编码。 acl_type String 类型 PERMIT (白名单类型) DENY (黑名单类型) acl_value String ACL策略值，支持一个或多个值，使用英文半角逗号分隔 entity_type String 对象类型： IP DOMAIN 请求消息样例： { "acl_name": "test001","acl_type": "PERMIT", "acl_value": "192.168.1.5,192.168.10.0/24,192.168.12.12-192.168.12.19", "entity_type": "IP"}

响应消息 表3 参数说明 名称 类型 说明 id String 编号 acl_name String 名称 acl_type String 类型 PERMIT（白名单类型） DENY（黑名单类型） acl_value String ACL策略值 entity_type String 对象类型： IP DOMAIN update_time Timestamp 更新时间 响应消息样例： {"id": "d402b35e-1054-4280-b1c5-0d741a28c995", "acl_name": "test", "entity_type": "IP","acl_type": "PERMIT", "acl_value": "192.168.1.5,192.168.10.0/24,192.168.12.12-192.168.12.19","update_time": "2017-11-18T14:27:36.918578+08:00"}

响应消息 表4 参数说明 名称 类型 说明 - 字典数据类型 API与签名密钥的绑定关系列表 表5 字典类型响应参数 名称 类型 说明 id String 绑定关系的ID api_id String API编号 api_name String API名称 api_remark String API描述 group_name String API所属分组的名称 api_type Integer API类型 sign_id String 签名密钥的编号 sign_name String 签名密钥的名称 sign_key String 签名密钥的key sign_secret String 签名密钥的密钥 env_id String API所属环境的编号 env_name String API所属环境的名称 binding_time Timestamp 绑定时间 publish_id String API发布ID 响应消息样例： [ { "id": "d8426fb090e442c4a56a35e451bea085", "api_id": "3c6769c6-ec61-4b45-b478-c60310dbaa1b", "api_name": "bbb", "api_remark": "", "group_name": "asd", "api_type": 1, "sign_id": "3a793b65a9034bdfae08924f149bfb4a", "sign_name": "signature01", "sign_key": "abcd_1234", "sign_secret": "******", "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "env_name": "RELEASE", "binding_time": "2018-02-07T03:17:26.396039456Z", "publish_id": "23234202f5834ab69113fc1b790b6bed" }, { "id": "97952732e6d7452d99de02db99acce27", "api_id": "d85c502a-f916-47e8-bba0-50537a2d1af2", "api_name": "aaa", "api_remark": "", "group_name": "asd", "api_type": 1, "sign_id": "3a793b65a9034bdfae08924f149bfb4a", "sign_name": "signature01", "sign_key": "abcd_1234", "sign_secret": "******", "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "env_name": "RELEASE", "binding_time": "2018-02-07T03:17:26.39803282Z", "publish_id": "6581f68efddc4ff0815e156ec6ecfb52" }]

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法 请求方法 URI POST /v1/{project_id}/apigw/instances/{instance_id}/sign-bindings URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。 instance_id 是 String 实例ID，可从API网关控制台的专享版实例信息中获取。

请求消息 表3 参数说明 名称 是否必选 类型 说明 sign_id 是 String 签名密钥编号 publish_ids 是 Array of strings API的发布记录编号 请求参数样例： { "sign_id": "3a793b65a9034bdfae08924f149bfb4a", "publish_ids": [ "374a6d5a-20c7-4ea1-82e1-19fce4556956", "65e6fe53-1ac3-4481-ba36-9f0bc6f22057" ]}

对象模型 本节介绍VPC通道的对象模型。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 VPC通道对象模型 参数 类型 说明 操作类型 是否必选 id String VPC通道的编号 R - name String VPC通道的名称 CRU 是 type Integer VPC通道的类型 2：Builtin通道类型 CRU 是 status Integer VPC通道的状态 1：正常 2：异常 R 是 project_id String 租户的编号 CRU 是 port Integer 端口 CR 是 balance_strategy Integer 分发算法 1：加权轮询（wrr） 2：加权最少连接（wleastconn） 3：源地址哈希（source） 4：URI哈希（uri） CRU 是 create_time Timestamp 创建时间 R 是 表2 健康检查对象模型 参数 类型 说明 操作类型 是否必选 id String 健康检查的编号 R - vpc_id String VPC通道的编号 CRU 是 protocol String 协议 tcp http CRU 是 path Integer 路径，仅当协议为http时生效 CRU 否 port Integer 端口，无值时，使用通道端口 CRU 否 threshold_normal Integer 正常阈值 CRU 是 threshold_abnormal Integer 异常阈值 CRU 是 time_out Integer 超时时间 CRU 是 time_interval Integer 间隔时间 CRU 是 http_code String 成功状态码，仅当协议为http时生效 CRU 否 create_time Timestamp 创建时间 R 是 表3 后端实例对象模型 参数 类型 说明 操作类型 是否必选 id String 后端实例对象的编号 R - vpc_id String VPC通道的编号 CRU 是 ext_vpc_id String 后端实例对象的主机关联的VPC的编号 该字段已废弃 R 是 instance_id String 实例的编号 CRU 否 instance_name String 实例的名称 CRU 否 host String 后端实例对象的主机地址 CRU 是 status Integer 后端实例对象状态 1：正常 2：异常 R 是 weight Integer 权重值 CRU 是 create_time Timestamp 创建时间 R 是 父主题： VPC通道管理（待下线）

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/apis/runtime/{id}[?env_id] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值：env_id。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。 instance_id 是 String 实例ID，可从API网关控制台的专享版实例信息中获取。 id 是 String API的编号

响应消息 表4 参数说明 参数 类型 说明 id String API编号 name String API名称 group_id String API所属分组的编号 group_name String API所属分组的名称 type Integer API类型 version String API版本 req_protocol String API访问协议 req_method String API请求方式 req_uri String API访问地址 auth_type String API认证方式 auth_opt 字段数据类型 API认证方式参数 authorizer_id String 前端自定义认证对象的ID match_mode String API匹配方式 remark String API描述 bakend_type String 后端类型 run_env_name String 发布的环境名 run_env_id String 发布的环境id publish_id String 发布记录的编号 tag String 服务名称标签，待废弃字段 tags []String 标签 cors Bool 是否支持跨域访问 body_remark String API请求体描述，可以是请求体示例、媒体类型、参数等信息 result_normal_sample String 正常响应示例，描述API的正常返回信息 result_failure_sample String 失败返回示例，描述API的异常返回信息 sl_domain String 分组的二级 域名 req_params 字典数据类型 API的请求参数列表 表5 req_params参数说明 参数 类型 说明 id String 参数编号 name String 参数名称 type String 参数类型 location String 参数位置 default_value String 参数默认值 sample_value String 参数示例值 required Integer 是否必须 valid_enable Integer 是否开启校验 remark String 描述 enumerations String 参数枚举值 min_num Integer 参数最小值（参数类型为NUMBER时有效） max_num Integer 参数最大值（参数类型为NUMBER时有效） min_size Integer 参数最小长度 max_size Integer 参数最大长度 regular String 正则校验规则 json_schema String JSON校验规则 表6 auth_opt参数说明 参数 类型 说明 app_code_auth_type String AppCode简易认证类型 响应消息样例： { "name": "market_api01", "type": 1, "version": "V0.0.1", "req_protocol": "HTTPS", "req_method": "GET", "req_uri": "/test01", "auth_type": "APP", "auth_opt": { "app_code_auth_type": "HEADER" }, "tags": ["APIG-SN-test", "test"], "cors": true, "match_mode": "NORMAL", "backend_type": "MOCK", "remark": "market_api01", "group_id": "7f848adc971749cda9c6aff3877cfc3e", "body_remark": "market_api01", "result_normal_sample": "success", "result_failure_sample": "", "id": "0e51b689e0784bc884f43756bbf34fa5", "group_name": "market_group01", "run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "run_env_name": "RELEASE", "publish_id": "f07eb9f5e5ba4bbfbe89326f5cae99c7", "sl_domain": "61297835ff1e4905b6f635dbcdf1777e.apigw.example.com", "req_params": [ { "name": "project_id", "type": "STRING", "location": "PATH", "default_value": "", "sample_value": "", "required": 1, "valid_enable": 2, "remark": "", "enumerations": "", "min_num": 0, "max_num": 0, "min_size": 0, "max_size": 0, "regular": "", "json_schema": "", "id": "2a61905ea2304186a9422faba2940735" } ]}

响应消息 表3 参数说明 名称 类型 说明 common_name String 证书域名 san 字典数据类型 SAN域名 version String 证书版本 organization 字典数据类型 公司、组织 organizational_unit 字典数据类型 部门 locality 字典数据类型 城市 state 字典数据类型 省份 country 字典数据类型 国家 not_before Timestamp 证书有效期起始时间 not_after Timestamp 证书有效期截止时间 serial_number String 序列号 issuer 字典数据类型 颁发者 signature_algorithm String 签名算法

请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、“_”组成，且只能以英文或中文开头。 type 是 String 自定义认证类型： FRONTEND：前端 BACKEND：后端 authorizer_type 是 String 只能为：FUNC authorizer_uri 是 String 函数urn identities 否 List 认证来源 ttl 否 Integer 缓存时间 user_data 否 String 用户数据

响应消息 表5 参数说明 名称 类型 说明 id String 编号 name String 自定义认证的名称 type String 自定义认证类型： FRONTEND：前端 BACKEND：后端 authorizer_type String 只能为：FUNC authorizer_uri String 函数urn identities Array 认证来源 ttl Integer 缓存时间 user_data String 用户数据 create_time Time 创建时间

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1/{project_id}/apigw/instances/{instance_id}/authorizers URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。 instance_id 是 String 实例ID，可从API网关控制台的专享版实例信息中获取。

请求消息 表3 参数说明 名称 是否必选 类型 说明 name 是 String 自定义认证的名称。 长度为3 ~ 64位的字符串，字符串由中文、英文字母、数字、“_”组成，且只能以英文或中文开头。 type 是 String 自定义认证类型： FRONTEND：前端 BACKEND：后端 authorizer_type 是 String 只能为：FUNC authorizer_uri 是 String 函数urn identities 否 List 认证来源 ttl 否 Integer 缓存时间 user_data 否 String 用户数据

响应消息 表5 参数说明 名称 类型 说明 id String 编号 name String 自定义认证的名称 type String 自定义认证类型： FRONTEND：前端 BACKEND：后端 authorizer_type String 只能为：FUNC authorizer_uri String 函数urn identities Array 认证来源 ttl Integer 缓存时间 user_data String 用户数据 create_time Time 创建时间

URI HTTP/HTTPS请求方法以及URI如表3-73所示。 表1 HTTP/HTTPS请求方法以及 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/sign-bindings/unbinded-apis[?page_size, page_no, sign_id, env_id, api_id, api_name, group_id] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值：sign_id、env_id、api_id、api_name、group_id、page_size、page_no。

请求消息 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。 instance_id 是 String 实例ID，可从API网关控制台的专享版实例信息中获取。 sign_id 是 String 安全密钥编号 env_id 否 String 环境编号 api_id 否 String API编号 api_name 否 String API名称 group_id 否 String API分组编号

响应消息 表3 参数说明 名称 类型 说明 total Integer 满足查询条件的API的总个数 size Integer 本次查询返回的API列表长度 apis 字典数据类型 本次查询返回的API列表 表4 apis参数说明 参数 类型 说明 id String API编号 name String API名称 type Integer API类型 remark String API描述 group_id String API所属分组的编号 group_name String API所属分组的名称 run_env_name String 发布的环境名 run_env_id String 发布的环境id publish_id String API的发布记录编号 signature_name String 已绑定的签名密钥名称 auth_type String API的认证方式 req_uri String API的访问地址 响应消息样例： {"total": 2,"size": 2,"apis": [{"name": "bbb","type": 1,"group_id": "7ccc0b94-eb5a-48e6-8554-6d0105a540e2","id": "3c6769c6-ec61-4b45-b478-c60310dbaa1b","group_name": "asd","run_env_name": "das","run_env_id": "1fdcb2e4-f90a-4159-817d-98c9b8e8b215","publish_id": "6dff16c4-813f-486a-bba4-fdad45a55a70","auth_type": "NONE","req_uri": "/test"},{"name": "aaa","type": 1,"group_id": "7ccc0b94-eb5a-48e6-8554-6d0105a540e2","id": "d85c502a-f916-47e8-bba0-50537a2d1af2","group_name": "asd","run_env_name": "das","run_env_id": "1fdcb2e4-f90a-4159-817d-98c9b8e8b215","publish_id": "dec83400-a0c6-4ea6-abfd-5bf237292f4d","auth_type": "NONE","req_uri": "/test"}]}

响应消息 表3 参数说明 参数 类型 说明 id String API编号 name String API名称 group_id String API所属分组的编号 group_name String API所属分组的名称 status Integer API的状态 type Integer API类型 version String API版本 req_protocol String API访问协议 req_method String API请求方式 req_uri String API访问地址 auth_type String API认证方式 auth_opt 字段数据类型 API认证方式参数 authorizer_id String 前端自定义认证对象的ID match_mode String API匹配方式 register_time Timestamp API创建时间 update_time Timestamp API修改时间 remark String API描述 bakend_type String 后端类型 run_env_name String 发布的环境名 run_env_id String 发布的环境id publish_id String 发布记录的编号 arrange_necessary Integer 是否需要编排 tag String 服务名称标签，待废弃字段 tags []String 标签 cors Bool 是否支持跨域访问 body_remark String API请求体描述，可以是请求体示例、媒体类型、参数等信息 result_normal_sample String 正常响应示例，描述API的正常返回信息 result_failure_sample String 失败返回示例，描述API的异常返回信息 backend_api 字典数据类型 后端服务：web后端详情 mock_info 字典数据类型 后端服务：MOCK详情 func_info 字典数据类型 后端服务： 函数工作流 后端详情 req_params 字典数据类型 API的请求参数列表 backend_params 字典数据类型 API的后端参数列表 policy_https 字典数据类型 web策略后端列表 policy_mocks 字典数据类型 mock策略后端列表 policy_functions 字典数据类型 函数工作流策略后端列表 表4 backend_api参数说明 参数 类型 说明 id String 编号 status Integer 状态 url_domain String 后端endpoint version String 版本 req_protocol String 访问协议 req_method String 访问方式 req_uri String 访问地址 timeout Integer 访问超时时间，单位：毫秒 register_time Timestamp 创建时间 update_time Timestamp 修改时间 remark String 描述 vpc_status String 是否使用VPC通道 vpc_info String VPC通道信息 authorizer_id String 后端自定义认证对象的ID 表5 mock_info参数说明 参数 类型 说明 id String 编号 status Integer 状态 version String 版本 result_content String 返回结果 register_time Timestamp 创建时间 update_time Timestamp 修改时间 remark String 描述 表6 func_info参数说明 参数 类型 说明 id String 编号 status Integer 状态 version String 版本 function_urn String 函数URN invocation_type String 调用类型：async|sync register_time Timestamp 创建时间 update_time Timestamp 更新时间 timeout Integer 超时时间，单位：毫秒 remark String 描述 表7 req_params参数说明 参数 类型 说明 id String 参数编号 name String 参数名称 type String 参数类型 location String 参数位置 default_value String 参数默认值 sample_value String 参数示例值 required Integer 是否必须。 1：必须 2：非必须 valid_enable Integer 是否开启校验 remark String 描述 enumerations String 参数枚举值 min_num Integer 参数最小值（参数类型为NUMBER时有效） max_num Integer 参数最大值（参数类型为NUMBER时有效） min_size Integer 参数最小长度 max_size Integer 参数最大长度 regular String 正则校验规则（暂不支持） json_schema String JSON校验规则（暂不支持） 表8 backend_params参数说明 参数 类型 说明 id String 参数编号 req_param_id String 对应的请求参数编号 name String 参数名称 location String 参数位置 origin String 参数类别 value String 参数值 remark String 描述 表9 policy_https参数说明 参数 类型 说明 id String 编号 name String 策略后端名称 url_domain String 策略后端endpoint req_protocol String 访问协议 req_method String 访问方式 req_uri String 访问地址 timeout Integer 访问超时时间，单位：毫秒 vpc_status String 是否使用VPC通道 vpc_info String VPC通道信息 effect_mode String 关联的策略组合模式 conditions 字典数据类型 策略条件列表 backend_params 字典数据类型 后端参数列表 表10 policy_mocks参数说明 参数 类型 说明 id String 编号 name String 策略后端名称 result_content String 返回结果 effect_mode String 关联的策略组合模式 conditions 字典数据类型 策略条件列表 backend_params 字典数据类型 后端参数列表 表11 policy_functions参数说明 参数 类型 说明 id String 编号 name String 策略后端名称 version String 版本 function_urn String 函数URN invocation_type String 调用类型:async|sync timeout Integer 超时时间，单位：毫秒 effect_mode String 关联的策略组合模式 conditions 字典数据类型 策略条件列表 backend_params 字典数据类型 后端参数列表 表12 conditions参数说明 参数 类型 说明 id String 编号 condition_type String 策略条件 condition_value String 策略值 condition_origin String 策略类型 req_param_name String 关联的请求参数对象名称 req_param_id String 关联的请求参数对象编号 req_param_location String 关联的请求参数对象位置 表13 auth_opt参数说明 参数 类型 说明 app_code_auth_type String AppCode简易认证类型 响应消息样例： { "name": "test", "type": 1, "version": "V0.0.1", "req_protocol": "HTTPS", "req_method": "GET", "req_uri": "/test/{tenant_id}", "auth_type": "APP", "auth_opt": { "app_code_auth_type": "DISABLE" }, "tags": ["APIG-SN-test", "test"], "cors": false, "match_mode": "NORMAL", "backend_type": "HTTP", "group_id": "f71f69876f90456ca6fd18ed012fdc11", "result_normal_sample": "hello world!", "id": "81efcfd94b8747a0b21e8c04144a4e8c", "status": 1, "arrange_necessary": 2, "register_time": "2018-08-15T03:41:11.0239936Z", "update_time": "2018-08-15T03:41:11.0239936Z", "group_name": "group0002", "backend_api": { "url_domain": "xxxxxxxxxxx", "req_protocol": "HTTP", "req_method": "GET", "req_uri": "/test", "timeout": 1000, "vpc_status": 2, "id": "3442ffd031814e3a8f133a9f1ea08453", "status": 1, "register_time": "2018-08-15T03:41:11.1019236Z", "update_time": "2018-08-15T03:41:11.1019236Z" }, "req_params": [ { "name": "tenant_id", "type": "STRING", "location": "PATH", "required": 1, "valid_enable": 2, "id": "593c5560e0924e00af08fb458f850ecb" }, { "name": "city", "type": "STRING", "location": "QUERY", "required": 2, "valid_enable": 2, "id": "e0b91bc81ae54f8ea850848d782d6e1e" } ], "backend_params": [ { "name": "tenant_id", "location": "QUERY", "origin": "REQUEST", "value": "tenant_id", "id": "44e03de2351e43a8b18ba9ec1e71d2e9", "req_param_id": "593c5560e0924e00af08fb458f850ecb" }, { "name": "city", "location": "QUERY", "origin": "REQUEST", "value": "city", "id": "b60fbcb5b86f4f5c8705c445b9bd6325", "req_param_id": "e0b91bc81ae54f8ea850848d782d6e1e" } ], "policy_https": [{ "conditions": [{ "id": "44e03de2351e43a8b18ba9ec1e71d2e9", "condition_type": "pattern", "condition_value": "^[0-9]$", "condition_origin": "param", "req_param_name": "project_id", "req_param_id": "b60fbcb5b86f4f5c8705c445b9sda325", "req_param_location": "PATH" }], "backend_params": [{ "name": "project_id", "value": "bbbb", "location": "QUERY", "origin": "REQUEST", "id": "44e03de2351e43a8b18ba9ec1e71d2e8", "req_param_id": "593c5560e0924e00af08fb458f850ecb" }], "effect_mode": "ANY", "id": "44e03de2351e43a8b18ba9ec1e71d2e8", "name": "policy001", "req_method": "GET", "req_protocol": "http", "req_uri": "/test/policy", "timeout": 10000, "url_domain": "xxxxxxxxxxx", "vpc_status": 2 }]}

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/apis/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。 instance_id 是 String 实例ID，可从API网关控制台的专享版实例信息中获取。 id 是 String API的编号

响应消息 表2 参数说明 名称 类型 说明 instance_num Integer API总个数 nums_off_release Integer 未发布到release环境的API个数 nums_on_release Integer 已发布到release环境的API个数 响应消息样例： {"instance_num": 3,"nums_off_release": 1,"nums_on_release": 2}

响应消息 表4 参数说明 名称 类型 说明 id String 自定义域名的编号 url_domain String 自定义域名 status Integer 解析状态值 ssl_id String 证书的编号 ssl_name String 证书的名称 响应消息样例： {"id": " b9be707660c5406394f8973e087bae20","url_domain": "www.example.com","status": 3,"ssl_id ": "0a515af69f4e4dcca84fbf85f68c0e27","ssl_name": "证书"}

URI HTTP/HTTPS请求方法以及URI如下表所示 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id 是 String 项目ID。可从控制台“我的凭证”中获取region下项目ID，管理员权限可查询。 instance_id 是 String 实例ID，可从API网关控制台的专享版实例信息中获取。 group_id 是 String 分组的编号 domain_id 是 String 域名的编号

请求消息 表3 参数说明 参数 是否必选 类型 说明 name 是 String 证书名称。 长度为4 ~ 50位的字符串，字符串由中文、英文字母、数字、"_"组成，且只能以英文或中文开头。 说明： 中文字符必须为UTF-8或者unicode编码。 cert_content 是 String 证书内容。 private_key 是 String 私钥内容。 请求消息样例： {"cert_content": "example","name": "test_ssl","private_key": "example"}

对象模型 本节介绍签名密钥的对象模型，如下表所示： “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 签名密钥模型 参数 类型 说明 操作类型 是否必选 id String 签名密钥的编号 R - name String 签名密钥的名称 CRU 是 sign_key String 签名密钥的key CRU 是 sign_secret String 签名密钥的密钥 CRU 是 create_time Timestamp 创建时间 R - update_time Timestamp 更新时间 R - 父主题： 签名密钥管理

响应消息 表3 参数说明 参数 类型 说明 id String 签名密钥的编号 name String 签名密钥的名称 sign_key String 签名密钥的key sign_secret String 签名密钥的密钥 create_time Timestamp 创建时间 update_time Timestamp 更新时间 响应消息样例： {"name": "signature01","sign_key": "abcd_123","sign_secret": "******","id": "3a793b65a9034bdfae08924f149bfb4a","create_time": "2018-02-06T12:17:36.039953112Z","update_time": "2018-02-06T12:17:36.039954198Z"}

请求消息 表2 参数说明 参数 是否必选 类型 说明 name 是 String 签名密钥的名称。 支持汉字，英文，数字，下划线，且只能以英文和汉字开头，3 ~ 64字符。 说明： 中文字符必须为UTF-8或者unicode编码。 sign_key 否 String 签名密钥的key。 支持英文，数字，下划线，中划线，且只能以数字或英文字母开头，8 ~ 32字符。 未填写时后台自动生成。 sign_secret 否 String 签名密钥的密钥。 支持英文，数字，下划线，中划线，!，@，#，$，%，且只能以数字或英文字母开头，16 ~ 64字符。 未填写时后台自动生成。 请求消息样例： {"name": "signature01","sign_key": "abcd_123","sign_secret": "******"}

功能介绍 为了保护API的安全性，建议租户为API的访问提供一套保护机制，即租户开放的API，需要对请求来源进行认证，不符合认证的请求直接拒绝访问。 其中，签名密钥就是API安全保护机制的一种。 租户创建一个签名密钥，并将签名密钥与API进行绑定，则API网关在请求这个API时，就会使用绑定的签名密钥对请求参数进行 数据加密 ，生成签名。当租户的后端服务收到请求时，可以校验这个签名，如果签名校验不通过，则该请求不是API网关发出的请求，租户可以拒绝这个请求，从而保证API的安全性，避免API被未知来源的请求攻击。

URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及 请求方法 URI GET /v1.0/apigw/sign-bindings/binded-apis[?page_size, page_no, sign_id, env_id, api_id, api_name, group_id] 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。 查询条件可为以下字段以及对应的值：sign_id、env_id、api_id、api_name、group_id、page_size、page_no。 URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 sign_id 是 String 签名密钥编号 env_id 否 String 环境编号 api_id 否 String API编号 api_name 否 String API名称 group_id 否 String API分组编号

响应消息 表3 参数说明 名称 类型 说明 total Integer 本次查询满足条件的API总数 size Integer 本次查询返回的API列表长度 bindings 字典数据类型 本次查询返回的API列表 表4 bindings参数说明 参数 类型 说明 id String 绑定关系的ID api_id String API编号 api_name String API名称 api_remark String API描述 group_name String API所属分组的名称 api_type Integer API类型 sign_id String 签名密钥的编号 sign_name String 签名密钥的名称 sign_key String 签名密钥的key sign_secret String 签名密钥的密钥 env_id String API所属环境的编号 env_name String API所属环境的名称 binding_time Timestamp 绑定时间 publish_id String API的发布编号 响应消息样例： { "total": 2, "size": 2, "bindings": [ { "id": "4588ec6f5dab4f67b298dc693f58029e", "api_id": "d85c502a-f916-47e8-bba0-50537a2d1af2", "api_name": "aaa", "api_remark": "", "group_name": "asd", "api_type": 1, "sign_id": "3a793b65a9034bdfae08924f149bfb4a", "sign_name": "signature01", "sign_key": "abcd_1234", "sign_secret": "******", "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "env_name": "RELEASE", "binding_time": "2018-02-07T07:08:51Z", "publish_id": "3a793b65a9034bdfae08924f149bfsda" }, { "id": "d8426fb090e442c4a56a35e451bea085", "api_id": "3c6769c6-ec61-4b45-b478-c60310dbaa1b", "api_name": "bbb", "api_remark": "", "group_name": "asd", "api_type": 1, "sign_id": "3a793b65a9034bdfae08924f149bfb4a", "sign_name": "signature01", "sign_key": "abcd_1234", "sign_secret": "******", "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "env_name": "RELEASE", "binding_time": "2018-02-07T03:17:26Z", "publish_id": "3a793b65a9034bdfae08924f149bfsda" } ]}