签名密钥绑定关系管理-华为云

API网关 APIG-查看签名密钥未绑定的API列表:响应示例

响应示例状态码： 200 OK { "total" : 1, "size" : 1, "apis" : [ { "run_env_name" : "RELEASE", "group_name" : "api_group_001", "remark" : "Mock backend API", "publish_id" : "9f27d1dc4f4242a9abf88e563dbfc33d", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "name" : "Api_mock", "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "id" : "3a955b791bd24b1c9cd94c745f8d1aad", "type" : 1, "auth_type" : " IAM ", "req_uri" : "/test/mock" } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:api_name. Please refer to the support documentation" } 状态码： 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "APIG.3017", "error_msg" : "Signature key 0b0e8f456b8742218af75f945307173c does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

API网关 APIG 专享版-签名密钥绑定关系管理

API网关 APIG-查看签名密钥未绑定的API列表:URI

URI GET /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/unbinded-apis 表1 路径参数参数是否必选参数类型描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。表2 Query参数参数是否必选参数类型描述 offset 否 Long 偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0 缺省值：0 limit 否 Integer 每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500 最小值：1 最大值：500 缺省值：20 sign_id 是 String 签名密钥编号 env_id 否 String 环境编号 api_id 否 String API编号 api_name 否 String API名称 group_id 否 String API分组编号 tags 否 String API标签，该参数可指定多个，多个不同的参数值为或关系；不指定或为空时，表示不筛选标签；指定为#no_tags#时，表示筛选无标签API。最小长度：0 最大长度：128

API网关 APIG 专享版-签名密钥绑定关系管理

API网关 APIG-查看签名密钥未绑定的API列表:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 apis Array of ApiForSign objects 本次查询返回的API列表表5 ApiForSign 参数参数类型描述 auth_type String API的认证方式 run_env_name String 发布的环境名 group_name String API所属分组的名称 publish_id String 发布记录的编号 group_id String API所属分组的编号 name String API名称 remark String API描述 run_env_id String 发布的环境id id String API编号 req_uri String API的请求地址 tags Array of strings API绑定的标签，标签配额默认10条，可以联系技术调整。最小长度：1 最大长度：128 数组长度：0 - 10 type Integer API类型 signature_name String 已绑定的签名密钥名称 req_method String API请求方法状态码： 400 表6 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 401 表7 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 403 表8 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 404 表9 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 500 表10 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述

API网关 APIG 专享版-签名密钥绑定关系管理

应用与数据集成平台 ROMA CONNECT-查看签名密钥未绑定的API列表:响应示例

响应示例状态码： 200 OK { "total" : 1, "size" : 1, "apis" : [ { "run_env_name" : "RELEASE", "group_name" : "api_group_001", "remark" : "Mock backend API", "publish_id" : "9f27d1dc4f4242a9abf88e563dbfc33d", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "name" : "Api_mock", "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "id" : "3a955b791bd24b1c9cd94c745f8d1aad", "type" : 1, "auth_type" : "IAM", "req_uri" : "/test/mock", "signature_name" : "" } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:api_name. Please refer to the support documentation" } 状态码： 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "APIG.3017", "error_msg" : "Signature key 0b0e8f456b8742218af75f945307173c does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

应用与数据集成平台 ROMA CONNECT 签名密钥绑定关系管理

应用与数据集成平台 ROMA CONNECT-查看签名密钥未绑定的API列表:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 apis Array of ApiForSign objects 本次查询返回的API列表表5 ApiForSign 参数参数类型描述 auth_type String API的认证方式 run_env_name String 发布的环境名 group_name String API所属分组的名称 publish_id String 发布记录的编号 group_id String API所属分组的编号 name String API名称 remark String API描述 run_env_id String 发布的环境ID id String API编号 req_uri String API的请求地址 type Integer API类型 signature_name String 已绑定的签名密钥名称状态码： 400 表6 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 401 表7 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 403 表8 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 404 表9 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 500 表10 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述

应用与数据集成平台 ROMA CONNECT 签名密钥绑定关系管理

应用与数据集成平台 ROMA CONNECT-绑定签名密钥:响应示例

响应示例状态码： 201 Created { "bindings" : [ { "api_id" : "5f918d104dc84480a75166ba99efff21", "sign_secret" : "dc0**********2b3", "group_name" : "api_group_001", "sign_id" : "0b0e8f456b8742218af75f945307173c", "sign_key" : "a071a20d460a4f639a636c3d7e3d8163", "binding_time" : "2020-08-03T04:00:11.638167852Z", "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "env_name" : "RELEASE", "sign_name" : "signature_demo", "api_type" : 1, "api_name" : "Api_http", "id" : "25082bd52f74442bb1d273993d567938", "api_remark" : "Web backend Api", "publish_id" : "66a645f1d6294fa6899cb1ed1c51bc4c", "sign_type" : "hmac" } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:sign_id. Please refer to the support documentation" } 状态码： 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "APIG.3017", "error_msg" : "Signature key 0b0e8f456b8742218af75f945307173c does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

应用与数据集成平台 ROMA CONNECT 签名密钥绑定关系管理

应用与数据集成平台 ROMA CONNECT-绑定签名密钥:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。表3 请求Body参数参数是否必选参数类型描述 sign_id 是 String 签名密钥编号 publish_ids 是 Array of strings API的发布记录编号

应用与数据集成平台 ROMA CONNECT 签名密钥绑定关系管理

API网关 APIG-查看API绑定的签名密钥列表:响应消息

响应消息表3 参数说明名称类型说明 total Integer 本次查询满足条件的签名密钥总数 size Integer 本次查询返回的签名密钥列表长度 bindings 字典数据类型本次查询返回的签名密钥列表表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" } ]}

API网关 APIG 签名密钥绑定关系管理

API网关 APIG-查看API绑定的签名密钥列表:URI

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

API网关 APIG 签名密钥绑定关系管理

API网关 APIG-对象模型

对象模型本节介绍签名密钥与API的绑定关系的对象模型，如下表所示。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。表1 签名密钥与API绑定关系对象模型参数类型说明操作类型是否必选 id String 绑定关系的ID R - front_api_id String API编号 CR 是 sign_id String 签名密钥编号 CR 是 env_id String 环境编号 CR 是 create_time Timestamp 绑定时间 R 否父主题：签名密钥绑定关系管理（待下线）

API网关 APIG 签名密钥绑定关系管理（待下线）

云服务器内容精选

签名密钥绑定关系管理

7*24

备案

专业服务

退订

建议反馈

售前咨询热线