华为云用户手册

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 id String 字典ID。 name String 字典名称。 字符集：中文、英文字母、数字、下划线和空格。 约束：实例下唯一。 remark String 字典描述。 code String 字典编码。 字符集：英文字母、数字、下划线和空格。 约束：实例下唯一。 extend_one String 字典扩展字段1。 字符集：中文、英文字母、数字、下划线和空格。 extend_two String 字典扩展字段2。 字符集：中文、英文字母、数字、下划线和空格。 parent_code String 父字典编码，为空时代表自身就是最顶级字典。 type String 字典类型。 system: 代表系统内置字典，用户可编辑但不可删除。 user: 代表用户创建字典。 create_time String 创建时间。 update_time String 更新时间。 状态码：403 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 error_details String 具体错误消息。 request_id String 请求处理ID。

响应示例 状态码：200 OK { "id" : "string", "name" : "string", "remark" : "string", "code" : "string", "extend_one" : "string", "extend_two" : "string", "parent_code" : "string", "type" : "system", "create_time" : "2019-12-06T06:49:04Z", "update_time" : "2019-12-06T06:49:04Z" } 状态码：403 Forbidden { "error_code" : "ROMA.00000101", "error_msg" : "error summary", "error_details" : "some error details here", "request_id" : "13760c1fe8655e61209b75665e9bef43" }

响应示例 状态码：200 查询实例集群的消费组信息成功。 { "group" : { "members" : [ { "host" : "/172.31.1.102", "assignment" : [ { "topic" : "test", "partitions" : [ 0, 1, 2 ] } ], "member_id" : "consumer-1-6b8ee551-d499-47d4-9beb-ba1527496785", "client_id" : "consumer-1" } ], "state" : "STABLE", "group_id" : "test-consumer-group", "coordinator_id" : 2, "group_message_offsets" : [ { "partition" : 0, "lag" : 31396, "topic" : "test", "message_current_offset" : 935, "message_log_end_offset" : 32331 }, { "partition" : 0, "lag" : 0, "topic" : "aaaa", "message_current_offset" : 0, "message_log_end_offset" : 0 }, { "partition" : 1, "lag" : 31279, "topic" : "test", "message_current_offset" : 1058, "message_log_end_offset" : 32337 }, { "partition" : 1, "lag" : 0, "topic" : "aaaa", "message_current_offset" : 0, "message_log_end_offset" : 0 }, { "partition" : 2, "lag" : 31603, "topic" : "test", "message_current_offset" : 739, "message_log_end_offset" : 32342 } ], "assignment_strategy" : "range" } }

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 [数组元素] Array of ShowGroupResp objects 查询成功。 表3 ShowGroupResp 参数 参数类型 描述 group Array of ShowGroupEntity objects 消费组信息。 表4 ShowGroupEntity 参数 参数类型 描述 group_id String 消费组的名称。 state String 消费组状态。包含以下状态： Dead：消费组内没有任何成员，且没有任何元数据。 Empty：消费组内没有任何成员，存在元数据。 PreparingRebalance：准备开启rebalance。 CompletingRebalance：所有成员加入group。 Stable：消费组内成员可正常消费。 coordinator_id Integer 协调器编号。 members Array of MemberEntity objects 消费者列表。 group_message_offsets Array of GroupMessageOffsetsEntity objects 消费进度。 assignment_strategy String 分区分配策略。 表5 MemberEntity 参数 参数类型 描述 host String 消费组consumer地址。 assignment Array of AssignmentEntity objects consumer分配到的分区信息。 member_id String 消费组consumer的ID。 client_id String 客户端ID。 表6 AssignmentEntity 参数 参数类型 描述 topic String Topic名称。 partitions Array of integers 分区列表。 表7 GroupMessageOffsetsEntity 参数 参数类型 描述 partition Integer 分区编号。 lag Integer 剩余可消费消息数，即消息堆积数。 topic String Topic名称。 message_current_offset Integer 当前消费进度。 message_log_end_offset Integer 最大消息位置（LEO）。

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "auths" : [ { "id" : "dd29b33ae4394e3b924b582c6b40880b", "api_id" : "5f918d104dc84480a75166ba99efff21", "api_name" : "Api_http", "group_name" : "api_group_001", "api_type" : 1, "api_remark" : "Web backend Api", "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "auth_role" : "PROVIDER", "auth_time" : "2020-08-04T04:02:22Z", "app_name" : "app_demo", "app_remark" : "remark", "app_type" : "roma", "app_creator" : "USER", "publish_id" : "", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "auth_tunnel" : "NORMAL", "auth_whitelist" : [ ], "auth_blacklist" : [ ], "roma_app_type" : "roma_client", "env_name" : "RELEASE", "app_id" : "356de8eb7a8742168586e5daf5339965" } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:app_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.3002", "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 auths Array of ApiAuthInfo objects 本次返回的API列表 表5 ApiAuthInfo 参数 参数类型 描述 id String 授权关系编号 api_id String API的编号 api_name String API的名称 group_name String API绑定的分组名称 api_type Integer API类型 api_remark String API的描述信息 env_id String api授权绑定的环境ID auth_role String 授权者 auth_time String 授权创建的时间 app_name String APP的名称 app_remark String APP的描述 app_type String APP的类型： apig：存量apic客户端，新建实例不支持此类型 roma：roma集成客户端 app_creator String APP的创建者，取值如下： USER：租户自己创建 MARKET：API市场分配，暂不支持 publish_id String API的发布编号 group_id String API绑定的分组ID auth_tunnel String 授权通道类型 NORMAL：普通通道 GREEN：绿色通道 auth_whitelist Array of strings 绿色通道的白名单配置 auth_blacklist Array of strings 绿色通道的黑名单配置 visit_param String 访问参数。 roma_app_type String ROMA_APP的类型： subscription：订阅应用 integration：集成应用 tags Array of strings API绑定的标签，标签配额默认10条，可以联系技术调整。 env_name String api授权绑定的环境名称 app_id String APP的编号 状态码： 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 错误描述

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "histories" : [ { "ld_api_id" : "bd42841c20184da6bbf457c6d8a06e37", "test_date" : "2020-09-19T06:40:52Z", "test_id" : 2524356, "test_method" : "GET", "test_operator" : "73d69ae0cfcf460190522d06b60f05ad", "test_request" : "{\"apiUUID\":\"bd42841c20184da6bbf457c6d8a06e37\",\"method\":\"GET\",\"params\":[{\"paramDesc\":\"\",\"paramName\":\"header\",\"paramRequired\":\"0\",\"paramType\":\"Headers\",\"paramValue\":\"test\"}],\"testUrl\":\"/test/function\"}", "test_response" : "Hello world!", "test_status_code" : "200", "test_used_time" : 29 } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:instance_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.3084", "error_msg" : "The livedata API does not exist, id: bd42841c20184da6bbf457c6d8a06e37" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 histories Array of LdApiTestHistoryInfoV2 objects 本次查询到的测试结果对象列表 表5 LdApiTestHistoryInfoV2 参数 参数类型 描述 test_status_code String 测试返回的状态码 test_request String 测试的请求内容 test_used_time Integer 测试耗时 test_operator String 测试者的项目编号 test_response String 测试的响应内容 test_method String 测试的请求方法 test_id Integer 测试编号 test_date String 测试时间 ld_api_id 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 错误描述

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "items" : [ { "id" : 711537, "parent_device_id" : 711536, "parent_device_name" : "parent-device", "product" : { "product_id" : 116303, "product_name" : "p1", "manufacturer_id" : "p1", "model" : "p1", "product_type" : 0, "protocol_type" : 0 }, "device_name" : "device", "instance_id" : "8993a690-cf61-46af-880d-587d823d14e5", "client_id" : "D116303711537sGDtK", "node_id" : "string", "status" : 0, "online_status" : 2, "description" : "device", "authentication" : { "user_name" : "F01A8D25FE6E4CF5A286B711B31888AE", "password" : "************************" }, "created_user" : { "user_id" : "", "user_name" : "user" }, "last_updated_user" : { "user_id" : "", "user_name" : "user" }, "tags" : [ ], "created_datetime" : 1607408244841, "last_updated_datetime" : 1607422571094, "connect_address" : "xx.xx.xx.xx", "ssl_connect_address" : "xx.xx.xx.xx", "ipv6_connect_address" : "xx.xx.xx.xx", "ipv6_ssl_connect_address" : "xx.xx.xx.xx", "app_id" : "cb4b3ec0-8f7f-432f-b05e-fc149d05da5d" } ] } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-device.batchQuerySubDevices]. Parameter is [deviceOid]. Processor is [path].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" } 状态码： 404 Not Found { "error_code" : "SCB.00000000", "error_msg" : "Not Found", "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01" } 状态码： 500 Internal Server Error { "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }

响应示例 状态码： 200 OK { "name" : "Api_http", "type" : 1, "version" : "V0.0.1", "req_protocol" : "HTTPS", "req_method" : "GET", "req_uri" : "/test/http", "auth_type" : "AUTHORIZER", "authorizer_id" : "8d0443832a194eaa84244e0c1c1912ac", "auth_opt" : { "app_code_auth_type" : "DISABLE" }, "cors" : false, "match_mode" : "NORMAL", "backend_type" : "HTTP", "remark" : "Web backend Api", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "result_normal_sample" : "Normal response example", "result_failure_sample" : "Failure response example", "id" : "5f918d104dc84480a75166ba99efff21", "group_name" : "api_group_001", "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "run_env_name" : "RELEASE", "publish_id" : "9191cdb430724d4b8586ed7f1b962ca2", "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ] } 状态码： 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.3002", "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应示例 状态码： 200 OK { "content_type" : "json", "created_time" : "2020-09-18T09:25:59Z", "description" : "", "id" : "bd42841c20184da6bbf457c6d8a06e37", "instance" : "f0fa1789-3b76-433b-a787-9892951c620e", "method" : "GET", "modified_time" : "2020-09-18T09:25:59Z", "name" : "livedata_api_demo", "parameters" : [ ], "path" : "/test/function", "return_format" : false, "roma_app_id" : "98df09fb-d459-4cbf-83a7-2b55ca6f3d5d", "scripts" : [ ], "status" : 1, "type" : "", "version" : "1.0.1" } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName: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.3084", "error_msg" : "The livedata API does not exist, id: bd42841c20184da6bbf457c6d8a06e37" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

请求示例 { "content_type" : "json", "method" : "GET", "name" : "livedata_api_demo", "path" : "/test/function", "return_format" : false, "roma_app_id" : "98df09fb-d459-4cbf-83a7-2b55ca6f3d5d", "version" : "1.0.1" }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表4 请求Body参数 参数 是否必选 参数类型 描述 throttle_bindings 否 Array of strings 需要解除绑定的API和流控策略绑定关系ID列表

响应示例 状态码： 200 OK { "failure" : [ { "bind_id" : "b11e5970f732440dbea647580647d57f", "error_code" : "APIG.3012", "error_msg" : "The request throttling policy binding record does not exist" } ], "success_count" : 1 } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "parameter action should be \\\"delete\\\"" } 状态码： 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.3030", "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 success_count Integer 成功解除绑定的API和流控策略绑定关系的数量 failure Array of ThrottleBindingBatchFailure objects 解除绑定失败的API和流控绑定关系及错误信息 表6 ThrottleBindingBatchFailure 参数 参数类型 描述 bind_id String 解除绑定失败的API和流控策略绑定关系ID error_code String 解除绑定失败的错误码 error_msg String 解除绑定失败的错误信息 api_id String 解除绑定失败的API的ID api_name String 解除绑定失败的API的名称 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 OK { "app_id" : "98df09fb-d459-4cbf-83a7-2b55ca6f3d5d", "config_name" : "app-config-demo", "config_type" : "password", "config_value" : "******", "description" : "", "id" : "a8bf4963c54544be81d5af4cc4630bde", "update_time" : "2020-09-07T07:10:07.601494336Z" } 状态码： 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.3081", "error_msg" : "authorizer with id: 0d982c1ac3da493dae47627b6439fc5c not found" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 config_type 是 String 应用配置类型： variable：模板变量 password：密码 certificate：证书 config_value 否 String 应用配置值： config_type = variable：config_value为模板变量的值 config_type = password：config_value为密码值 config_type = certificate：调用创建或修改应用配置接口，config_value值非必填，自定义后端函数使用config_value值需要包含证书public_key（必填），私钥private_key（必填）和密码passphrase（非必填），格式如："{\"public_key\": ",\"private_key\":\"\",\"passphrase\":\"\"}" description 否 String 应用配置描述

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id String 应用配置编号 app_id String 应用编号 config_type String 应用配置类型 config_name String 应用配置名称 config_value String 应用配置值 update_time String 应用配置更新时间 description String 应用配置描述 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:instance_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.3084", "error_msg" : "The livedata API does not exist, id: bd42841c20184da6bbf457c6d8a06e37" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

请求示例 为指定命令创建一个请求属性，数据类型为Integer，属性非必填，并设置最小和最大值。 { "property_name" : "power_usage", "description" : "power_usage", "data_type" : "integer", "required" : 0, "min" : "0", "max" : "100", "step" : "1", "unit" : "W" }

响应示例 状态码： 200 Created { "property_id" : 3320, "property_name" : "p2", "description" : null, "data_type" : "datetime", "required" : 0, "min" : 0, "max" : 65536, "step" : 1, "max_length" : "10", "unit" : "yuan", "enum_list" : null, "method" : "RWE" } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-services-requests.saveCommandSend]. Parameter is [service_id]. Processor is [path].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" } 状态码： 404 Not Found { "error_code" : "ROMA.00110006", "error_msg" : "The resource does not exist. Check whether the resource ID 1 is correct.", "request_id" : "13984193-ca65-4954-9b7f-4b7d680399d6-1619678681445-cnnorth7a-P-romalink-service01" } 状态码： 500 Internal Server Error { "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 property_id Integer 属性ID。 property_name String 属性名称，首位必须为字母，支持大小写字母、数字、中划线及下划线，长度2-50。 description String 属性描述，长度0-200。 data_type String 属性数据类型，boolean枚举值大小写敏感；number格式为数字，范围±1.0 x 10^-28 to ±7.9228 x 10^28；string为字符串；integer为整数；datetime为时间，格式为yyyyMMddTHHmmss；json为自定义json格式； array为数组类型。 required Integer 是否必填，0-非必填，1-必填。 min String 最小值，当data_type为integer或number时有效。 max String 最大值，当data_type为integer或number时有效。 step String 步长，当data_type为integer或number时有效。 max_length Integer 字符串最大长度，当data_type为string、datetime、json时有效。 unit String 属性单位。 enum_list String string的枚举值数组，使用逗号分隔，单个长度取决于max_length参数。 enum_dict Object 当数据类型为boolean枚举值时填写json格式数据，形如"enum_dict":{"0":"xxx","1":"xxx"}。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 error_msg String 错误描述。 request_id String 消息ID。 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 error_msg String 错误描述。 request_id String 消息ID。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 error_msg String 错误描述。 request_id String 消息ID。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 property_name 是 String 属性名称，首位必须为字母，支持大小写字母、数字、中划线及下划线，长度2-50。 description 否 String 属性描述，长度0-200。 data_type 是 String 属性数据类型，boolean枚举值大小写敏感；number格式为数字，范围±1.0 x 10^-28 to ±7.9228 x 10^28；string为字符串；integer为整数；datetime为时间，格式为yyyyMMddTHHmmss；json为自定义json格式； array为数组类型。 required 是 Integer 是否必填，0-非必填，1-必填。 min 否 String 最小值，当data_type为integer或number时必填。 max 否 String 最大值，当data_type为integer或number时必填。 step 否 String 步长，当data_type为integer或number时必填。 max_length 否 Integer 字符串最大长度，当data_type为string、datetim、 json时必填，自动向下取整。 unit 否 String 属性单位。 enum_list 否 String string的枚举值数组，使用逗号分隔，单个长度取决于max_length参数。 enum_dict 否 Object 当数据类型为boolean枚举值时填写json格式数据，形如"enum_dict":{"0":"xxx","1":"xxx"}。 method 否 String 访问模式（兼容20.0，R属性可读，W属性可写，E属性可执行）。

响应示例 状态码： 200 OK { "total" : 2, "size" : 2, "tags" : [ "webApi", "functionApi" ] } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:instance_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.3030", "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620e" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 tags Array of strings 标签列表 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 201 Created { "api_id" : "5f918d104dc84480a75166ba99efff21", "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "publish_id" : "9191cdb430724d4b8586ed7f1b962ca2", "publish_time" : "2020-08-03T01:36:00.592970615Z", "version_id" : "ee1a5a38d3d3493abf1dc4ed6cacfa0b", "remark" : "" } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:action. 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.3002", "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 需要进行的操作。 online：发布 offline：下线 api_id 是 String API的编号，即：需要进行发布或下线的API的编号 env_id 是 String 环境的编号，即：API需要发布到哪个环境 remark 否 String 对发布动作的简述。字符长度不超过255 说明： 中文字符必须为UTF-8或者unicode编码。

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 publish_id String 发布记录的ID api_id String API编号 api_name String API名称 env_id String 发布的环境编号 remark String 发布描述 publish_time String 发布时间 version_id String 在线的版本号 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求示例 https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}/topics/{topic_name}/access-policies/batch-add { "policies" : [ { "user_name" : "62034763-c4aa-416f-975d-1452ba90fec2", "app_name" : "app-uve7", "access_policy" : "sub", "tag" : "123&abc" } ] }