华为云用户手册

响应示例 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:domain_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.3020", "error_msg" : "The URL domain 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参数 参数 是否必选 参数类型 描述 certificate_ids 是 Array of strings 证书的id集合 verified_client_certificate_enabled 否 Boolean 是否开启客户端证书校验。当绑定证书存在trusted_root_ca时，默认开启；当绑定证书不存在trusted_root_ca时，默认关闭。

请求示例 修改指定数据集成普通任务，修改源端和目标端配置 { "task" : { "task_name" : "fdi_task_v2mysql-tomysql", "task_type" : "TIMING", "source_datasource_id" : "30969b205e8f4392a25fb321112d1753", "target_datasource_id" : "30969b205e8f4392a25fb321112d1753", "description" : "mysql", "task_tag" : "fdi_autotest" }, "task_detail" : "{\"sourceSelectedDatasource\":{\"dataTimestamp\":1606807799782,\"isNeedPageSrcApi\":true,\"pageKeySrcApi\":\"pageNum\",\"pageSizeKeySrcApi\":\"pageSize\",\"resultTotalRootPath\":\"\",\"isUseDynamicSignal\":false,\"timeshift\":\"\",\"startTimeKey\":\"\",\"beginDateColSrcApi\":\"beginTime\",\"endDateColSrcApi\":\"endTime\",\"rootPath\":\"\",\"sourceParams\":[{\"keys\":\"pageNum\",\"value\":\"0\"},{\"keys\":\"pageSize\",\"value\":\"10\"},{\"keys\":\"beginTime\",\"value\":\"1\"},{\"keys\":\"endTime\",\"value\":\"1\"}],\"sourceHeaders\":[],\"sourceBodyType\":\"raw-json\",\"bodyRaw\":\"{\\\"pageNum\\\":\\\"1\\\",\\\"pageSize\\\":\\\"10\\\"}\",\"sourceBodyFormData\":[],\"sourceResponseType\":\"json\",\"sourceMetaData\":{\"dataSource\":[{\"index\":0,\"name\":\"name\",\"type\":\"String\",\"format\":\"\",\"path\":\"\"},{\"index\":1,\"name\":\"age\",\"type\":\"Integer\",\"format\":\"\",\"path\":\"\"}],\"mode\":\"keyValue\"},\"incr_migration_type\":\"systemDefault\",\"period_granularity\":\"\",\"period_assignment\":\"\",\"period_right_boarder\":\"\",\"pagingEndType\":\"paging-list\",\"pagingEndFieldPath\":\"\",\"pageNumLimit\":\"1\",\"servicetype\":\"None\",\"current_page_num\":\"1\",\"page_size\":\"10\",\"need_inc_migration\":true,\"date_form\":\"unix_ms\",\"timeZone\":\"GMT+08:00\",\"reset_incr_begin_time\":false,\"compensation_time\":\"0\",\"advanceStartTime\":\"0\",\"advanceStartTimeUnit\":\"day\",\"isParse\":\"true\"},\"targetSelectedDatasource\":{\"targetNeedCreateTable\":false,\"isSupportClearTab\":false,\"targetTable\":\"CDCMODEL.NODE\",\"batchNumber\":\"\",\"targetSelectedColumnList\":[{\"field_name\":\"NODE_ID\",\"field_type\":\"VARCHAR2\",\"field_length\":\"64\",\"null_able\":\"0\",\"unique\":\"1\"},{\"field_name\":\"AVAILABILITY_ZONE\",\"field_type\":\"VARCHAR2\",\"field_length\":\"64\",\"null_able\":\"0\",\"unique\":\"0\"},{\"field_name\":\"CACHE_PORT\",\"field_type\":\"VARCHAR2\",\"field_length\":\"8\",\"null_able\":\"0\",\"unique\":\"0\"},{\"field_name\":\"FLOATING_IP_ADDRESS\",\"field_type\":\"VARCHAR2\",\"field_length\":\"32\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"NAME\",\"field_type\":\"VARCHAR2\",\"field_length\":\"64\",\"null_able\":\"0\",\"unique\":\"0\"},{\"field_name\":\"NODE_TYPE\",\"field_type\":\"VARCHAR2\",\"field_length\":\"255\",\"null_able\":\"0\",\"unique\":\"0\"},{\"field_name\":\"PRIVATE_IP\",\"field_type\":\"VARCHAR2\",\"field_length\":\"32\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"USER_NAME\",\"field_type\":\"VARCHAR2\",\"field_length\":\"64\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"PRIVATE_KEY\",\"field_type\":\"VARCHAR2\",\"field_length\":\"2048\",\"null_able\":\"0\",\"unique\":\"0\"},{\"field_name\":\"ROOT_PASSWORD\",\"field_type\":\"VARCHAR2\",\"field_length\":\"2048\",\"null_able\":\"0\",\"unique\":\"0\"},{\"field_name\":\"SERVER_ID\",\"field_type\":\"VARCHAR2\",\"field_length\":\"64\",\"null_able\":\"0\",\"unique\":\"0\"},{\"field_name\":\"STATUS\",\"field_type\":\"VARCHAR2\",\"field_length\":\"255\",\"null_able\":\"0\",\"unique\":\"0\"},{\"field_name\":\"SUBNET_ID\",\"field_type\":\"VARCHAR2\",\"field_length\":\"64\",\"null_able\":\"0\",\"unique\":\"0\"},{\"field_name\":\"SUBNET_NAME\",\"field_type\":\"VARCHAR2\",\"field_length\":\"256\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"INSTANCE_ID\",\"field_type\":\"VARCHAR2\",\"field_length\":\"64\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"DATAVOLUME_ID\",\"field_type\":\"VARCHAR2\",\"field_length\":\"64\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"CACHE_ROLE\",\"field_type\":\"VARCHAR2\",\"field_length\":\"255\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"RES_SUBNET_IP\",\"field_type\":\"VARCHAR2\",\"field_length\":\"32\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"SYSTEMVOLUME_ID\",\"field_type\":\"VARCHAR2\",\"field_length\":\"64\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"SYSADMIN_PASSWORD\",\"field_type\":\"VARCHAR2\",\"field_length\":\"2048\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"NEW_ROOT_PASSWD\",\"field_type\":\"VARCHAR2\",\"field_length\":\"2048\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"NEW_SYSADMIN_PASSWD\",\"field_type\":\"VARCHAR2\",\"field_length\":\"2048\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"ROOT_PASSWORD_OVERDUE_TIME\",\"field_type\":\"TIMESTAMP(6)\",\"field_length\":\"0\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"OPERATION_MSG\",\"field_type\":\"VARCHAR2\",\"field_length\":\"2048\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"RES_SUBNET_IP_BETA\",\"field_type\":\"VARCHAR2\",\"field_length\":\"32\",\"null_able\":\"1\",\"unique\":\"0\"},{\"field_name\":\"METRIC_DATA\",\"field_type\":\"VARCHAR2\",\"field_length\":\"2048\",\"null_able\":\"1\",\"unique\":\"0\"}],\"supportPartUpdate\":false},\"mappingTable\":[],\"mappingInput\":{\"dataSource\":[{\"sourceKey\":\"name\",\"targetKey\":\"RES_SUBNET_IP_BETA\"},{\"sourceKey\":\"age\",\"targetKey\":\"METRIC_DATA\"}]},\"mappingRequired\":true,\"error_handler\":{\"path\":\"data1\",\"datasource_id\":\"79c4caaa3e1441dfb0351038fcf5f281\",\"mode\":\"OBS\",\"app_id\":\"73965e3c-72b2-40c3-8335-2154ebd6c23a\",\"stop_task_when_obs_failure\":false},\"afterImplementation\":{\"actionType\":\"KAFKA\",\"appId\":\"73965e3c-72b2-40c3-8335-2154ebd6c23a\",\"datasourceId\":\"a87a31a6288e4698865be122ae485dc0\",\"topic\":\"lgytest99\",\"messageContent\":\"success\"}}" }

响应示例 状态码： 200 OK { "task" : { "task_id" : "15366328208d4d77b76532fe9f4006a6", "task_name" : "fdi_task_v2mysql-tomysql", "task_type" : "timing", "status" : "stop", "project_id" : "c53626012ba84727b938ca8bf03108ef", "source_datasource_id" : "30969b205e8f4392a25fb321112d1753", "target_datasource_id" : "30969b205e8f4392a25fb321112d1753", "source_datasource_name" : "fdi_ds_testmysqlv2", "target_datasource_name" : "fdi_ds_testmysqlv2", "source_app_id" : "eaaa8ad0-f967-416a-ab73-d995ef656e89", "target_app_id" : "eaaa8ad0-f967-416a-ab73-d995ef656e89", "source_app_name" : "app-testV2-interface", "target_app_name" : "app-testV2-interface", "created_date" : 1605288733684, "last_modified_date" : 1605288733684, "description" : "crate task", "task_tag" : "fdi_autotest" }, "task_detail" : "{\"needAPI\":false,\"targetDsId\":\"7049282e5678490d8e5a5c55d77638f6\",\"sourceSelectedDatasource\":{\"extend_meta_data\":[],\"orderType\":\"ASC\",\"sourceDateColumn\":\"\",\"dataTimestamp\":\"\",\"sourceTable\":\"mydb.tb_tmp01\",\"sourceSelectedColumnList\":[{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"11\",\"field_type\":\"INT\",\"field_name\":\"id\"},{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"25\",\"field_type\":\"VARCHAR\",\"field_name\":\"name\"},{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"11\",\"field_type\":\"INT\",\"field_name\":\"deptId\"},{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"11\",\"field_type\":\"INT\",\"field_name\":\"age\"}],\"isParse\":\"true\",\"querySql\":\"\",\"whereOptions\":[],\"instanceId\":\"02a7726e-1fc2-44b5-ae96-84a2b5f0e660\",\"sourceMetaData\":{\"dataSource\":[]},\"isAddSql\":false,\"meta_data\":[],\"where\":[],\"need_inc_migration\":false,\"textInputValue\":\"\",\"orderColumn\":\"\",\"isTextInput\":false},\"targetDatasource\":\"mysql\",\"needEmailNew\":false,\"description\":\"\",\"mappingTableProperties\":[{\"sourceNullable\":\"1\",\"sourceUnique\":\"0\",\"targetUnique\":\"0\",\"targetNullable\":\"1\"},{\"sourceNullable\":\"1\",\"sourceUnique\":\"0\",\"targetUnique\":\"0\",\"targetNullable\":\"1\"},{\"sourceNullable\":\"1\",\"sourceUnique\":\"0\",\"targetUnique\":\"0\",\"targetNullable\":\"1\"},{\"sourceNullable\":\"1\",\"sourceUnique\":\"0\",\"targetUnique\":\"0\",\"targetNullable\":\"1\"}],\"sourceDatasourceType\":\"MYSQL\",\"taskType\":2,\"sourceDatasource\":\"mysql\",\"targetDatasourceType\":\"MYSQL\",\"mappingSourceTextOrNot\":[{\"flag\":false},{\"flag\":false},{\"flag\":false},{\"flag\":false}],\"mappingTable\":[{\"targetColumnType\":\"INT\",\"isAddDateMapping\":false,\"targetColumnLength\":\"11\",\"isAddMapping\":false,\"isAddBooleanMapping\":false,\"sourceColumnLength\":\"11\",\"targetColumn\":\"id\",\"sourceColumnType\":\"Int\",\"isAddFDIUUIDMapping\":false,\"sourceColumn\":\"id\"},{\"targetColumnType\":\"VARCHAR\",\"isAddDateMapping\":false,\"targetColumnLength\":\"25\",\"isAddMapping\":false,\"isAddBooleanMapping\":false,\"sourceColumnLength\":\"25\",\"targetColumn\":\"name\",\"sourceColumnType\":\"Varchar\",\"isAddFDIUUIDMapping\":false,\"sourceColumn\":\"name\"},{\"targetColumnType\":\"INT\",\"isAddDateMapping\":false,\"targetColumnLength\":\"11\",\"isAddMapping\":false,\"isAddBooleanMapping\":false,\"sourceColumnLength\":\"11\",\"targetColumn\":\"deptId\",\"sourceColumnType\":\"Int\",\"isAddFDIUUIDMapping\":false,\"sourceColumn\":\"deptId\"},{\"targetColumnType\":\"INT\",\"isAddDateMapping\":false,\"targetColumnLength\":\"11\",\"isAddMapping\":false,\"isAddBooleanMapping\":false,\"sourceColumnLength\":\"11\",\"targetColumn\":\"age\",\"sourceColumnType\":\"Int\",\"isAddFDIUUIDMapping\":false,\"sourceColumn\":\"age\"}],\"targetSelectedDatasource\":{\"targetNeedCreateTable\":false,\"targetSelectedColumnList\":[{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"11\",\"field_type\":\"INT\",\"field_name\":\"id\"},{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"25\",\"field_type\":\"VARCHAR\",\"field_name\":\"name\"},{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"11\",\"field_type\":\"INT\",\"field_name\":\"deptId\"},{\"null_able\":\"1\",\"unique\":\"0\",\"field_length\":\"11\",\"field_type\":\"INT\",\"field_name\":\"age\"}],\"supportPartUpdate\":false,\"targetTable\":\"mydb.tb_tmp01_target\",\"instanceId\":\"02a7726e-1fc2-44b5-ae96-84a2b5f0e660\",\"batch_number_style\":\"UUID\",\"isSupportClearTab\":false,\"batchNumber\":\"\"},\"taskName\":\"fdi_task_5ykjp7\",\"sourceDsId\":\"7049282e5678490d8e5a5c55d77638f6\",\"projectId\":\"c53626012ba84727b938ca8bf03108ef\",\"needMQS\":false,\"mappingInput\":{},\"mappingRequired\":true}" }

响应示例 状态码： 200 OK { "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 } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-services-responses.queryCommandResponseDetail]. Parameter is [command_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 表3 响应Body参数 参数 参数类型 描述 property_id Integer 属性ID 最小值：1 最大值：99999999999999999 property_name String 属性名称，首位必须为字母，支持大小写字母，数字，中划线及下划线，长度2-50 最小长度：2 最大长度：50 description String 属性描述，长度0-200 最小长度：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为数组类型 最小长度：0 最大长度：10 required Integer 是否必填 0-非必填 1-必填 最小值：0 最大值：10 min String 最小值，当data_type为integer或number时有效 缺省值：0 最小长度：0 最大长度：10 max String 最大值，当data_type为integer或number时有效 缺省值：65536 最小长度：0 最大长度：10 step String 步长，当data_type为integer或number时有效 缺省值：1 最小长度：0 最大长度：10 max_length Integer 字符串最大长度，当data_type为string, datetime, json时有效 最小值：1 最大值：99999999 缺省值：10 unit String 属性单位 最小长度：0 最大长度：10 enum_list String string的枚举值数组，使用逗号分隔 最小长度：0 最大长度：2000 enum_dict Object 当数据类型为boolean枚举值时填写json格式数据，形如"enum_dict":{"0":"xxx","1":"xxx"} 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码 最小长度：0 最大长度：64 error_msg String 错误描述 最小长度：0 最大长度：200 request_id String 消息ID 最小长度：0 最大长度：64 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码 最小长度：0 最大长度：64 error_msg String 错误描述 最小长度：0 最大长度：200 request_id String 消息ID 最小长度：0 最大长度：64 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码 最小长度：0 最大长度：64 error_msg String 错误描述 最小长度：0 最大长度：200 request_id String 消息ID 最小长度：0 最大长度：64

响应示例 状态码： 200 OK { "id" : "5f918d104dc84480a75166ba99efff21", "tags" : [ "webApi" ], "arrange_necessary" : 2, "backend_type" : "HTTP", "auth_type" : "APP", "auth_opt" : { "app_code_auth_type" : "DISABLE" }, "backend_api" : { "update_time" : "2020-08-02T16:32:47.077028841Z", "vpc_channel_status" : 1, "vpc_channel_info" : { "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59", "vpc_channel_proxy_host" : "www.example.com" }, "url_domain" : "56a7d7358e1b42459c9d730d65b14e59", "req_protocol" : "HTTPS", "id" : "1ce8fda3586d4371bd83c955df37e102", "req_method" : "GET", "register_time" : "2020-07-31T12:42:51Z", "req_uri" : "/test/benchmark", "timeout" : 5000, "status" : 1 }, "cors" : false, "status" : 1, "group_name" : "api_group_001", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "group_version" : "V1", "match_mode" : "NORMAL", "name" : "Api_http", "req_protocol" : "HTTPS", "req_method" : "GET", "req_uri" : "/test/http", "type" : 1, "version" : "V0.0.1", "result_normal_sample" : "Normal response example", "result_failure_sample" : "Failure response example", "register_time" : "2020-07-31T12:42:51Z", "update_time" : "2020-08-02T16:32:47.046288842Z", "remark" : "Web backend API", "backend_params" : [ { "name" : "X-CONSTANT-HEADER", "value" : "demo", "location" : "HEADER", "origin" : "CONSTANT", "remark" : "constant_demo", "id" : "8cb2eba19e7a4423a4e835647a8b8d76" }, { "name" : "app-id", "value" : "$context.appId", "location" : "HEADER", "origin" : "SYSTEM", "remark" : "Application ID of the invoker.", "id" : "216ddda836e74d528f364ff589d9dd21" } ] } 状态码： 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.3002", "error_msg" : "API 5f918d104dc84480a75166ba99efff21 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

请求示例 修改指定API的配置信息，匹配模式改为绝对匹配，认证方式改为APP认证，Web后端改为使用负载通道，并新增后端参数 { "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "match_mode" : "NORMAL", "name" : "Api_http", "auth_type" : "APP", "backend_type" : "HTTP", "backend_api" : { "vpc_channel_status" : 1, "vpc_channel_info" : { "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59", "vpc_channel_proxy_host" : "www.example.com" }, "req_protocol" : "HTTPS", "req_method" : "GET", "req_uri" : "/test/benchmark", "timeout" : 5000 }, "cors" : false, "req_protocol" : "HTTPS", "req_uri" : "/test/http", "remark" : "Web backend API", "type" : 1, "req_method" : "GET", "result_normal_sample" : "Normal response example", "result_failure_sample" : "Failure response example", "backend_params" : [ { "name" : "X-CONSTANT-HEADER", "value" : "demo", "location" : "HEADER", "origin" : "CONSTANT", "remark" : "constant_demo" }, { "name" : "app-id", "value" : "$context.appId", "location" : "HEADER", "origin" : "SYSTEM", "remark" : "Application ID of the invoker." } ], "tags" : [ "webApi" ] }

响应示例 状态码： 200 OK { "variable_value" : "192.168.1.5", "env_id" : "7a1ad0c350844ee69479b47df9a881cb", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "id" : "25054838a624400bbf2267cf5b3a3f70", "variable_name" : "address" } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:variable_name" } 状态码： 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.3003", "error_msg" : "Environment 7a1ad0c350844ee69479b47df9a881cb 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参数 参数 是否必选 参数类型 描述 variable_value 是 String 变量值支持英文字母、数字、英文格式的下划线、中划线，斜线（/）、点、冒号，1 ~ 255个字符。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 variable_value String 变量值支持英文字母、数字、英文格式的下划线、中划线，斜线（/）、点、冒号，1 ~ 255个字符。 env_id String 环境编号 最小长度：1 最大长度：65 group_id String API分组编号 最小长度：1 最大长度：65 variable_name String 变量名，支持英文字母、数字、英文格式的下划线、中划线，必须以英文字母开头，3~32个字符。在API定义中等于#Name的值#部分（区分大小写），发布到环境里的API被变量值换。 说明： 中文字符必须为UTF-8或者unicode编码。 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 错误描述

响应示例 状态码： 200 OK { "size" : 1, "items" : [ { "id" : 14, "name" : "group_name", "parent_id" : 0, "children" : [ ] } ] } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-device-groups.selectGroupNodeTree]. Parameter is [app_id]. Processor is [query].", "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 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回数量 最小值：1 最大值：9999 items Array of GroupTreeResponse objects 设备分组信息 数组长度：0 - 9999 表5 GroupTreeResponse 参数 参数类型 描述 id Integer 分组id 最小值：1 最大值：99999999 name String 分组名称 最小长度：0 最大长度：200 parent_id Integer 父分组id 最小值：1 最大值：99999999 children Array of GroupTreeResponse objects 子分组 数组长度：0 - 9999 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码 最小长度：0 最大长度：64 error_msg String 错误描述 最小长度：0 最大长度：200 request_id String 消息ID 最小长度：0 最大长度：64 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码 最小长度：0 最大长度：64 error_msg String 错误描述 最小长度：0 最大长度：200 request_id String 消息ID 最小长度：0 最大长度：64 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码 最小长度：0 最大长度：64 error_msg String 错误描述 最小长度：0 最大长度：200 request_id String 消息ID 最小长度：0 最大长度：64

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 dispatch_id String 调度计划ID 最小长度：1 最大长度：64 task_id String 调度计划关联的任务ID 最小长度：1 最大长度：64 start_datetime Integer 调度计划的执行开始时间 最小值：0 最大值：99999999999999999 period String 调度计划执行周期的时间单位，当使用cron表达式时，为空 MIN (分钟) HOUR (小时) DAY (日) WEEK (周) MON (月) 最小长度：0 最大长度：36 dispatch_interval Integer 调度计划的执行间隔时间周期 最小值：1 最大值：59 created_date Integer 调度计划的创建时间 最小值：1 最大值：99999999999999999 last_modified_date Integer 调度计划最近一次的修改时间 最小值：1 最大值：99999999999999999 remark String 调度计划的备注信息 最小长度：8 最大长度：36 use_quartz_cron Boolean 调度计划是否使用cron表达式，允许如下值： true (使用cron表达式) false (不使用cron表达式) 最小长度：4 最大长度：16 cron String 调度计划的cron表达式 最小长度：8 最大长度：255 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

响应示例 状态码： 200 OK { "dispatch_id" : "a0f7fa9897da423dadbe8391d7ea7a43", "task_id" : "15366328208d4d77b76532fe9f4006a6", "start_datetime" : 1605339505609, "period" : "DAY", "dispatch_interval" : 1, "created_date" : 1605311230685, "last_modified_date" : 1605311230685, "remark" : "123", "use_quartz_cron" : false } 状态码： 400 Bad Request { "code" : 400, "reason" : { "error_code" : "FDI.3149", "error_msg" : "The task ID is empty." } } 状态码： 404 Not Found { "code" : 404, "reason" : { "error_code" : "FDI.3180", "error_msg" : "This task is not in the project." } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 start_datetime 否 Integer 调度计划的执行开始时间 最小值：0 最大值：99999999999999999 period 否 String 调度计划执行周期的时间单位，当使用cron表达式时，为空 MIN (分钟) HOUR (小时) DAY (日) WEEK (周) MON (月) 最小长度：0 最大长度：36 dispatch_interval 否 Integer 调度计划的执行间隔时间周期 最小值：1 最大值：59 remark 否 String 调度计划的备注信息 最小长度：8 最大长度：36 use_quartz_cron 否 Boolean 调度计划是否使用cron表达式，允许如下值： true (使用cron表达式) false (不使用cron表达式) 最小长度：4 最大长度：16 cron 否 String 调度计划的cron表达式 最小长度：8 最大长度：255

响应示例 状态码： 200 OK { "protocol" : "http", "path" : "/vpc/demo", "method" : "GET", "port" : 22, "threshold_abnormal" : 5, "threshold_normal" : 2, "time_interval" : 10, "http_code" : "200", "enable_client_ssl" : false, "status" : 1, "timeout" : 5, "id" : "3b3d02026c5f402d85e8645ea95b0816", "vpc_channel_id" : "d38c55c926ca44c2bfb37886d93b9a0d", "create_time" : "2020-07-23T07:11:57Z" } 状态码： 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" }

请求示例 修改指定VPC通道的健康检查配置，协议修改为HTTP，关闭双向认证 { "http_code" : "200", "path" : "/vpc/demo", "port" : 22, "protocol" : "http", "threshold_abnormal" : 5, "threshold_normal" : 2, "time_interval" : 10, "timeout" : 5, "enable_client_ssl" : false }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 protocol String 使用以下协议，对VPC中主机执行健康检查： TCP HTTP HTTPS path String 健康检查时的目标路径。protocol = http或https时必选 method String 健康检查时的请求方法 缺省值：GET port Integer 健康检查的目标端口，缺少或port = 0时为VPC中主机的端口号。 若此端口存在非0值，则使用此端口进行健康检查。 最小值：0 最大值：65535 threshold_normal Integer 正常阈值。判定VPC通道中主机正常的依据为：连续检查x成功，x为您设置的正常阈值。 最小值：1 最大值：10 threshold_abnormal Integer 异常阈值。判定VPC通道中主机异常的依据为：连续检查x失败，x为您设置的异常阈值。 最小值：1 最大值：10 time_interval Integer 间隔时间：连续两次检查的间隔时间，单位为秒。必须大于timeout字段取值。 最小值：5 最大值：300 http_code String 检查目标HTTP响应时，判断成功使用的HTTP响应码。取值范围为100到599之前的任意整数值，支持如下三种格式： 多个值，如：200,201,202 一系列值，如：200-299 组合值，如：201,202,210-299 protocol = http时必选 enable_client_ssl Boolean 是否开启双向认证。若开启，则使用实例配置中的backend_client_certificate配置项的证书 缺省值：false status Integer 健康检查状态 1：可用 2：不可用 timeout Integer 超时时间：检查期间，无响应的时间，单位为秒。必须小于time_interval字段取值。 最小值：2 最大值：30 vpc_channel_id String VPC通道的编号 id String 健康检查的编号 create_time 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 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 protocol 是 String 使用以下协议，对VPC中主机执行健康检查： TCP HTTP HTTPS path 否 String 健康检查时的目标路径。protocol = http或https时必选 method 否 String 健康检查时的请求方法 缺省值：GET port 否 Integer 健康检查的目标端口，缺少或port = 0时为VPC中主机的端口号。 若此端口存在非0值，则使用此端口进行健康检查。 最小值：0 最大值：65535 threshold_normal 是 Integer 正常阈值。判定VPC通道中主机正常的依据为：连续检查x成功，x为您设置的正常阈值。 最小值：1 最大值：10 threshold_abnormal 是 Integer 异常阈值。判定VPC通道中主机异常的依据为：连续检查x失败，x为您设置的异常阈值。 最小值：1 最大值：10 time_interval 是 Integer 间隔时间：连续两次检查的间隔时间，单位为秒。必须大于timeout字段取值。 最小值：5 最大值：300 http_code 否 String 检查目标HTTP响应时，判断成功使用的HTTP响应码。取值范围为100到599之前的任意整数值，支持如下三种格式： 多个值，如：200,201,202 一系列值，如：200-299 组合值，如：201,202,210-299 protocol = http时必选 enable_client_ssl 否 Boolean 是否开启双向认证。若开启，则使用实例配置中的backend_client_certificate配置项的证书 缺省值：false status 否 Integer 健康检查状态 1：可用 2：不可用 timeout 是 Integer 超时时间：检查期间，无响应的时间，单位为秒。必须小于time_interval字段取值。 最小值：2 最大值：30

服务集成API错误码 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 400 APIC.7244 Unsupported to update eip bandwidth 不支持更新带宽 不允许操作 400 APIC.7250 Invalid query param 无效的请求参数 使用正确的请求参数 400 APIC.7251 Invalid query param limit 无效的请求参数limit 使用正确的请求参数limit 400 APIC.7252 Invalid query param next_token 无效的请求参数next_token 使用正确的请求参数next_token 400 APIC.9206 create instance failed 创建实例失败 根据不同的原因处理，如果资源不足，则扩充资源，如果网络异常则检查对应服务的网络，恢复网络连通性。 400 APIC.9218 Create instance failed due to insufficient quota. 因配额不够创建实例失败 修改配额后重试 400 APIC.9219 Create instance failed due to insufficient resources. 因资源不够创建实例失败 资源扩容后重试 400 APIC.9220 Failed to update inbound access address of the instance 更新实例入口失败 请联系技术支持工程师协助解决 400 APIC.9221 Inbound access address of the instance cannot be updated. 不支持更新实例入口 不允许操作 400 APIG.1000 The token is missing. 未识别到用户认证信息，请重新登录或稍后重试 携带token访问 400 APIG.1119 No permissions to perform operations on this method. 细粒度授权失败，无权限执行此操作 获取对应细粒度权限后使用 400 APIG.1120 No permissions to create ELB channels. 没有权限创建私网ELB通道 所操作的ELB通道应在自己账号下，子账号应获取授权后访问 400 APIG.1201 The resources belong to different tenants. 操作的资源不属于同一租户 操作的对象应该属于同一个租户 400 APIG.2000 Parameter error. {x}请求参数错误 根据接口返回的具体原因修改请求参数 400 APIG.2001 The request parameters must be specified. {x}请求参数为空 根据接口返回的具体原因填写请求参数 400 APIG.2002 The parameter value is too small. {x}参数值小于最小值 根据接口返回的具体原因修改请求参数 400 APIG.2003 The parameter value is too large. {x}参数值大于最大值 根据接口返回的具体原因修改请求参数 400 APIG.2004 The parameter value is outside the allowable range. {x}参数值不在可选范围内 根据接口返回的具体原因修改请求参数 400 APIG.2005 The parameter is too short. 参数长度太短 根据接口返回的具体原因修改请求参数 400 APIG.2006 The parameter is too long. {x}参数长度太长 根据接口返回的具体原因修改请求参数 400 APIG.2007 Invalid length. 参数长度非法 根据接口返回的具体原因修改请求参数 400 APIG.2008 Only letters are allowed. 参数只能是字母 根据接口返回的具体原因修改请求参数 400 APIG.2009 Only digits are allowed. 参数只能是数字 根据接口返回的具体原因修改请求参数 400 APIG.2010 Only letters and digits are allowed. 参数只能是字母或数字 根据接口返回的具体原因修改请求参数 400 APIG.2011 Invalid parameter value. {x}参数规则不匹配 根据接口返回的具体原因修改请求参数 400 APIG.2012 Invalid parameter value. 参数匹配到不期望匹配的规则 根据接口返回的具体原因修改请求参数 400 APIG.2013 Only letters, digits, hyphens (-), and underscores (_) are allowed. 参数只能是字母、数字、下划线或中划线 根据接口返回的具体原因修改请求参数 400 APIG.2014 Invalid email address. 无效的邮件地址 根据接口返回的具体原因修改请求参数 400 APIG.2015 Invalid IP address. 无效的IP地址 参考可能原因修改请求参数 400 APIG.2016 The characters are not encoded using Base 64. 不是base 64编码的字符 修改请求参数为正确的base 64编码字符串 400 APIG.2017 Invalid mobile number. 无效的手机号码 根据接口返回的具体原因修改请求参数 400 APIG.2018 Invalid telephone number. 无效的固话号码 根据接口返回的具体原因修改请求参数 400 APIG.2019 Invalid telephone or mobile number. 无效的电话号码 根据接口返回的具体原因修改请求参数 400 APIG.2020 Invalid postal code. 无效的邮政编码 根据接口返回的具体原因修改请求参数 400 APIG.2021 The URL domain is not included in the IP address whitelist. 后端服务地址不在有效范围：{x} 修改后端地址在有效的后端服务地址范围内 400 APIG.2022 The URL domain is included in the IP address blacklist. 后端服务地址处于无效范围：{x} 修改后端地址在无效的后端服务地址范围外 400 APIG.2023 URL domain CNAME resolution failed. 您的域名未cname解析到该分组的子域名 先注册域名的cname解析记录 400 APIG.2024 Invalid URL domain. 域名非法 使用正确的域名 400 APIG.2025 Invalid backend port number. 无效的端口号 使用正确的端口号 400 APIG.2026 The request path parameters do not match the request URI. 请求路径与请求参数不匹配 将请求路径包含的参数添加到请求参数中 400 APIG.2027 The backend path parameters do not match the backend URI. 后端路径与后端参数不匹配 将后端请求路径包含的参数添加到后端参数中 400 APIG.2028 The backend parameters are not mapped to the request parameters. 请求参数和后端参数不匹配 后端参数中的参数来源，改为正确的请求参数 400 APIG.2030 Bad request for debugging the API. 调试请求定义错误 使用正确的API调试参数 400 APIG.2034 The domain name has not been filed. File it first. 域名未备案，请进入备案系统进行备案 进入备案系统进行备案 400 APIG.2035 The ICP Filing System is busy. Please try again later. 备案系统繁忙，请稍后重试 请联系技术支持工程师查看管理面后台日志，排查是否连接备案系统异常 400 APIG.2037 Plugin content invalid 插件内容错误 修改为正确插件内容 400 APIG.2038 Invalid cron expression cron表达式参数非法 cron表达式参数非法 400 APIG.2039 Only boolean are allowed 只允许布尔类型 参数类型使用布尔类型 400 APIG.2041 Invalid microservice. 微服务无效 Invalid microservice. 修改请求参数service_id为有效的微服务ID 400 APIG.2042 Invalid engine. 微服务引擎无效 修改请求参数engine_id为有效的微服务引擎ID 400 APIG.2043 Too many custom backends to take offline. 批量下线的自定义后端个数超过上限 减少批量下线的自定义后端个数 400 APIG.2101 The certificate and private key do not match. 证书与私钥不匹配 使用匹配的证书与私钥 400 APIG.2102 The certificate has expired. 证书过期 使用没有过期的证书 400 APIG.2103 The certificate common name does not match the domain name. 证书内域名与自定义域名不匹配 证书内的域名应与自定义域名相同 400 APIG.2104 The certificate chain is not matched. 证书链不匹配 包含了多个证书的证书链，需要将服务器证书放在第一个，后面依次放证书链证书 400 APIG.2105 Encrypted private keys are not supported. 不支持加密的私钥 使用没有加密的私钥 400 APIG.2106 Invalid certificate or private key. 无效的证书或私钥 使用正确的证书和私钥 400 APIG.2108 Microservice unavailable. 微服务不可用 修改请求参数service_id为可用的微服务ID 400 APIG.2109 Invalid certificate. SAN missing. 无效的证书，证书缺乏SAN 无效的证书，证书缺乏SAN，请重新生成带有SAN的证书 400 APIG.3141 The number of API tasks exceeds the maximum allowed limit API定时任务数量超过配额 请联系技术支持工程师增大配额 400 APIG.3145 The number of member groups exceeds the maximum allowed limit 负载通道服务器组个数超过配额 请联系技术支持工程师增大配额 400 APIG.3147 The number of kafka log plugins exceeds the maximum allowed limit kafka插件数量超过配额 请联系技术工程师增大配额 400 APIG.3148 Invalid certificate. Add one that expires before January 19, 2038 03:14:07 UTC. 证书到期日期不能超过 2038 年 1 月 19 日 03:14:07 UTC 之后的时间。 请添加一个在 2038 年 1 月 19 日 03:14:07 UTC 之前到期的证书。 400 APIG.3149 Too many MRS HBase data sources. MRS Hbase数据源数量超出限制 不允许操作 400 APIG.3201 The API group name already exists. 指定的API分组名称已存在 使用其他名称 400 APIG.3202 The API name already exists. 指定的API名称已存在 使用其他名称 400 APIG.3203 The app name already exists. 指定的应用名称已存在 使用其他名称 400 APIG.3204 The request throttling policy name already exists. 指定的流控策略名称已存在 使用其他名称 400 APIG.3205 The environment name already exists. 指定的环境名称已存在 使用其他名称 400 APIG.3206 The access control policy name already exists. 指定的ACL策略名称已存在 使用其他名称 400 APIG.3207 The signature key name already exists. 指定的签名密钥名称已存在 使用其他名称 400 APIG.3208 The VPC channel name already exists. VPC通道名称已存在 使用其他名称 400 APIG.3209 The parameter name already exists. 参数名称重复 使用其他名称 400 APIG.3210 The backend policy name already exists. 策略后端名称已存在 使用其他名称 400 APIG.3211 The authorizer name already exists. 指定的自定义认证名称已存在 使用其他名称 400 APIG.3212 he identity source name already exists. 指定的身份来源的请求参数名称已存在 使用其他名称 400 APIG.3213 The API tag name already exists. API标签名称已存在 使用其他名称 400 APIG.3215 The backend API name already exists. 自定义后端API名称已存在 使用其他名称 400 APIG.3216 The response name already exists. 网关响应名称已存在 使用其他名称 400 APIG.3301 The API already exists. API已存在 修改API的方法和url，避免与其他API冲突 400 APIG.3303 The environment variable already exists. 环境变量已存在 使用其他名称 400 APIG.3305 The URL domain name already exists. 域名已存在 请使用其他域名或检查域名是否已被使用 400 APIG.3306 The IP address already exists. 黑白名单IP地址重复 请检查黑白名单ip地址配置，删除重复ip 400 APIG.3309 The operation has already been performed. 操作已实施 请稍后重试或减少并发调用操作 400 APIG.3310 The AppKey already exist. APP key已存在 使用其他APP key 400 APIG.3311 The AppCode already exists. APP code已存在 使用其他APP code 400 APIG.3313 The API Swagger file already exists. swagger文档已存在 使用其他名称 400 APIG.3314 The backend API already exists. 自定义后端API已存在 修改自定义后端API的方法和url，避免与其他API冲突 400 APIG.3315 The returned object name already exists. 自定义后端返回对象名称重复 使用其他返回对象名称 400 APIG.3316 The API authorization relationship already exists. API和应用授权关系重复 使用其他API或APP授权 400 APIG.3317 The sign binding relationship already exists 签名密钥与API的绑定关系已存在 检查是否自定义后端使用的签名密钥与前端API绑定的签名密钥不一致 400 APIG.3318 The plugin name already exists 插件名称重复 使用其他名称 400 APIG.3319 The API task name already exists 指定的定时任务名称已存在 使用其他定时任务名称 400 APIG.3325 The APP quota name already exists. 客户端配额名称重复 使用其他名称 400 APIG.3326 The vpc channel member already exists 负载通道后端服务器已存在 使用其他的后端服务器 400 APIG.3328 The vpc channel member group already exists 指定的负载通道服务器组名称已存在 使用其他名称 400 APIG.3330 VPC already bound to a microservice. VPC已经绑定了微服务 修改请求参数vpc_channel_id为未绑定微服务的 400 APIG.3459 The api group version not match. 该分组的版本不匹配 修改分组时不对分组应用进行修改 400 APIG.3469 All the members must bound to member group or not 负载通道的服务器必须全部绑定服务器组或全部不绑定服务器组 修改负载通道的服务器全部绑定服务器组或全部不绑定服务器组 400 APIG.3471 No permissions to perform operations on this type of VPC channel. 无权限操作该类型负载通道 不允许操作 400 APIG.3472 The instance has been used by another VPC. 该负载通道后端实例已经被其它负载通道使用 解除实例与其他负载通道的绑定关系后使用 400 APIG.3473 The load balancer has already been bound to another endpoint service. 后端实例已经绑定了其它endpoint service 不允许操作 400 APIG.3474 The API group ID in the URL does not match the API group to which the URL domain has been bound. 分组与域名实际绑定的分组不一致 修改分组与域名绑定的分组一致 400 APIG.3475 The API group ID in the URL does not match the API group to which the certificate has been bound. 域名与证书绑定的域名不一致 修改域名与证书绑定的域名一致 400 APIG.3476 The domain ID in the URL does not match the domain to which the certificate has been bound. URL中的域名与证书绑定的域名不一致 URL中的域名与证书绑定的域名修改为一致 400 APIG.3477 The authorizer type and API do not match. 指定的自定义认证类型与API的使用位置不匹配 对不同的API认证位置使用正确类型的自定义认证 400 APIG.3479 No permissions to perform opreations on this ROMA integration application. 无法操作该集成应用 修改不同资源所属的集成应用一致 400 APIG.3489 The data source type is not supported. 不支持该数据源类型 使用正确的数据源类型 400 APIG.3494 The backend of API is livedata and cannot change. API的后端是自定义后端API不能修改 撤销部署自定义后端，修改后重新部署 400 APIG.3499 The API task logs cannot be queried when the API task status is init 初始化状态的定时任务不允许查看定时任务日志 定时任务启动后再查看定时任务日志 400 APIG.3600 Json or Yaml format error. Json或Yaml格式错误 请确认导入文件是否为yaml或者json，且格式正确 注：导入EXCEL文件也是这个报错 400 APIG.3601 The Swagger file version must be 2.0. swagger版本不是2.0 swagger版本必须为2.0 400 APIG.3602 Syntax error in the Swagger file. swagger语法错误 使用swagger编辑器检查swagger语法是否正确 400 APIG.3603 The Swagger file content is too long. swagger内容超过限制 缩小swagger文件大小 400 APIG.3604 Syntax error in the imported assets file. 导入的资产文件格式错误 检查资产文件格式 400 APIG.3605 The number of assets exceeds the maximum allowed limit. 资产数量超过限制 缩减资产数量 400 APIG.3606 Asset version transfer failed. 资产版本转换失败 修改资产版本与资产格式对应 400 APIG.3607 Valid external dependencies for assets fail. 找不到资产的依赖 重试或联系技术支持工程师检查是否数据面同步异常 400 APIG.3608 Cannot edit APIs in the API Designer. 没有权限操作API设计器创建的API 不允许操作，请操作其他API 400 APIG.3610 When the backend uses the load balance channel, the number of retry count cannot exceed the number of available backend servers in the load balance channel 使用负载通道的后端，重试次数必须小于负载通道后端可用的服务器数 修改重试次数必须小于负载通道后端可用的服务器数 401 APIC.7100 Token missing. 未识别到用户认证信息，请重新登录或稍后重试 携带token访问 401 APIC.7101 Token expired. 认证信息过期，请稍后重试 重新获取token访问 401 APIC.7102 Incorrect token or token resolution failure. 认证信息无法识别 请联系技术工程师检查是否token加解密配置异常 401 APIC.7103 Token contains no project information. 认证信息不包含project信息 获取token时携带project信息 401 APIC.7104 Token contains no domain information. 认证信息不包含用户的项目信息 获取token时携带用户的项目信息 401 APIC.7105 Token contains no user information. 认证信息不包含用户信息 获取token时使用用户信息 401 APIC.7107 Token contains no role information. 认证信息不包含角色信息 获取token时使用角色信息 401 APIG.1001 The token has expired. 会话过期，请稍后重试 重新获取token访问 401 APIG.1002 Incorrect token or token resolution failed. 认证信息无法识别 使用正确的token访问 401 APIG.1003 The token does not contain project information. 认证不包含project信息 使用包含project信息的token访问 401 APIG.1005 No permissions to request this method. 租户操作受限，请前往用户中心核实 使用包含所需权限的token访问 401 APIG.1009 The token does not contain user information. 认证不包含用户信息 使用包含用户信息的token访问 401 APIG.1010 PDP server connection failed. 连接细粒度授权服务器失败 请联系技术支持工程师查看管理面后台日志，排查是否连接IAM细粒度鉴权服务器异常 401 APIG.1011 You can request resources only after you complete real-name authentication. 您的账号未实名认证，暂时无法进行其他操作 实名认证后使用 401 APIG.1012 Your account balance is insufficient. Top up your account. 您的账户余额不足，请前往用户中心解决 充值后使用 401 APIG.1013 Your account has been frozen. Some functions become unavailable. 您的账户已被冻结，部分功能会受到影响 解除账号受限后使用 401 APIG.1144 No permissions to perform operations on this API task 没有权限操作该定时任务 所操作的定时任务应在自己账号下，子账号应获取授权后访问 401 APIG.1300 No permissions to perform operations on this project 没有权限操作此项目 使用正确项目下的租户token访问 401 APIG.3497 The ROMA APP to which the API task belongs cannot be changed 定时任务绑定的应用不允许更新 不允许操作 401 APIG.3498 The API task cannot be operated when the API task status is started 已启动的定时任务不允许操作 先停止定时任务后再操作 401 APIG.3700 The API task status is started and does not need to be started again 已启动的定时任务不允许重复启动 先停止定时任务再启动 401 APIG.3701 The API task status is init or stopped and does not need to be stopped again 已停止或初始化状态的定时任务不允许停止 启动定时任务后再停止 403 APIC.7106 No permissions to request for the method. 租户操作受限，请前往用户中心核实 使用包含所需权限的token访问 403 APIC.7108 Account frozen. No permissions to request the POST method. 账号冻结，没有权限访问 解除账号冻结状态后访问 403 APIC.7109 Account restricted. No permissions to request the POST method. 账号受限，没有权限访问 解除账号受限状态后访问 403 APIC.7110 Readonly account. No permissions to request any method except GET. 只读账户，没有权限发送除GET之外的任何请求 联系账号管理员配置管理员或细粒度权限 403 APIC.7111 Token not belong to the project in URI. 访问的资源不属于该账号 使用正确的token访问 403 APIC.7130 No permissions for operating the instance 没有权限操作其他项目下的实例 使用正确的项目编号 403 APIG.1020 Insufficient permissions. 当前用户权限不足 授予该用户读写权限 403 APIG.1101 No permissions to perform operations on this API group. 没有权限操作该API分组 所操作的分组应在自己账号下，子账号应获取授权后访问 403 APIG.1102 No permissions to perform operations on this API. 没有权限操作该API 所操作的API应在自己账号下，子账号应获取授权后访问 403 APIG.1103 No permissions to perform operations on this environment. 没有权限操作该环境 所操作的环境应在自己账号下，子账号应获取授权后访问 403 APIG.1104 No permissions to perform operations on this app. 没有权限操作该应用 所操作的应用应在自己账号下，子账号应获取授权后访问 403 APIG.1105 No permissions to perform operations on this request throttling policy. 没有权限操作该流控策略 所操作的流控策略应在自己账号下，子账号应获取授权后访问 403 APIG.1106 No permissions to perform operations on this access control policy. 没有权限操作该访问控制策略 所操作的ACL策略应在自己账号下，子账号应获取授权后访问 403 APIG.1109 No permissions to perform operations on this app authorization record. 没有权限操作该APP授权信息 所操作的APP授权应在自己账号下，子账号应获取授权后访问 403 APIG.1110 No permissions to perform operations on this environment variable. 没有权限操作该环境变量 所操作的环境变量应在自己账号下，子账号应获取授权后访问 403 APIG.1112 No permissions to perform operations on this signature key. 没有权限操作该签名密钥 所操作的签名密钥应在自己账号下，子账号应获取授权后访问 403 APIG.1113 No permissions to perform operations on this VPC channel. 没有权限操作该负载通道 所操作的复制通道应在自己账号下，子账号应获取授权后访问 403 APIG.1115 No permissions to perform operations on this certificate. 没有权限操作该证书 所操作的证书应在自己账号下，子账号应获取授权后访问 403 APIG.1136 No permissions to perform operations on this instance. 没有权限操作实例 确认使用的项目编号是否与实例所属项目编号一致 403 APIG.1137 No permissions to perform operations on this authorizer 没有权限操作该自定义认证 所操作的自定义认证应在自己账号下，子账号应获取授权后访问 403 APIG.1138 No permissions to perform operations on this data source. 没有权限操作该数据源 所操作的数据源应在自己账号下，子账号应获取授权后访问 403 APIG.1139 No permissions to perform operations on this livedata API 没有权限操作该自定义后端API 所操作的后端API应在自己账号下，子账号应获取授权后访问 403 APIG.1140 No permissions to perform operations on this feature 没有权限操作该特性 所操作的特性应在自己账号下，子账号应获取授权后访问 403 APIG.1141 No permissions to perform operations on this ROMA integration application. 没有权限操作roma集成应用 使用主账号或创建该roma集成应用的子账号对需要访问该集成应用的子账号授予相应的权限 403 APIG.1142 No permissions to perform operations on this client quota 没有权限操作客户端配额 使用管理员账号操作客户端配额 403 APIG.1143 No permissions to perform operations on this plugin 没有权限操作插件 所操作的插件应在自己账号下，子账号应获取授权后访问 403 APIG.1149 No permission for this instance task. 没有权限操作此实例异步任务 使用正确项目下的租户token访问 403 APIG.1200 No permissions to perform operations on this API Swagger file. 没有权限创建操作该swagger文档 所操作的API文档应在自己账号下，子账号应获取授权后访问 403 APIG.3066 The roma auth tunnel does not exist. 集成应用绿色通道授权类型不存在 检查绿色通道授权类型是否正确 403 APIG.3100 The number of resources exceeds the maximum allowed limit. 请求的资源数量超过限额 请联系技术支持工程师增大配额 403 APIG.3101 The number of API groups exceeds the maximum allowed limit. API分组数量超过限额 请联系技术支持工程师增大配额 403 APIG.3102 The number of APIs exceeds the maximum allowed limit. API数量超过限额 请联系技术支持工程师增大配额 403 APIG.3103 The number of apps exceeds the maximum allowed limit. 应用数量超过限额 请联系技术支持工程师增大配额 403 APIG.3104 The number of environments exceeds the maximum allowed limit. 环境数量超过限额 请联系技术支持工程师增大配额 403 APIG.3105 The number of signature keys exceeds the maximum allowed limit. 签名密钥数量超过限额 请联系技术支持工程师增大配额 403 APIG.3106 The number of variables exceeds the maximum allowed limit. 变量个数超过限额 请联系技术支持工程师增大配额 403 APIG.3107 The number of request throttling policies exceeds the maximum allowed limit. 流控策略个数超过限额 请联系技术支持工程师增大配额 403 APIG.3108 The number of domain names exceeds the maximum allowed limit. 分组自定义域名个数超过限额 请联系技术支持工程师增大配额 403 APIG.3109 The number of VPC channels exceeds the maximum allowed limit. 负载通道数量超过限额 请联系技术支持工程师增大配额 403 APIG.3110 The number of instances exceeds the maximum allowed limit. 负载通道中的弹性云服务器数量超过限额 请联系技术支持工程师增大配额 403 APIG.3111 The number of parameters in req_params exceeds the maximum allowed limit. API参数个数超过限额 请联系技术支持工程师增大配额 403 APIG.3112 The number of access control policies exceeds the maximum allowed limit. 访问控制策略个数超过限额 请联系技术支持工程师增大配额 403 APIG.3113 The maximum number of API backend policies has been reached. API的策略后端个数超过限额 请联系技术支持工程师增大配额 403 APIG.3114 The maximum number of policy conditions has been reached. 策略后端的策略条件个数超过限额 请联系技术支持工程师增大配额 403 APIG.3116 The number of custom authorizers exceeds the maximum allowed limit. 自定义认证超过配额 请联系技术支持工程师增大配额 403 APIG.3117 The number of identity sources exceeds the maximum allowed limit. 自定义认证身份信息来源超过配额 请联系技术支持工程师增大配额 403 APIG.3125 The maximum number of APIs for one API group has been reached. 分组内的API数量达到上限 请联系技术支持工程师增大配额 403 APIG.3127 The number of APIs has reached the upper limit. A maximum of xxx APIs can be imported at a time. 导入API数量超过限制，每次最多导入数量为：xxx 减少导入的api数量 403 APIG.3131 The number of AppCodes exceeds the maximum allowed limit. APP code数量超过限额 请联系技术支持工程师增大配额 403 APIG.3132 The number of Swagger API files exceeds the maximum limit allowed for an API group. swagger文档数量超过限额 请联系技术支持工程师增大配额 403 APIG.3133 The number of API tags exceeds the maximum allowed limit. 标签数量超过限额 请联系技术支持工程师增大配额 403 APIG.3134 The number of livedata APIs exceeds the maximum allowed limit. 自定义后端API数量超过配额限制 请联系技术支持工程师增大配额 403 APIG.3135 The number of API scripts exceeds the maximum allowed limit. 自定义后端API脚本数量超过配额限制 请联系技术支持工程师增大配额 403 APIG.3136 The number of responses exceeds the maximum allowed limit. 网关响应数量超过限额 请联系技术支持工程师增大配额 403 APIG.3138 The number of Configurations for one APP exceeds the maximum allowed limit. 应用配置数量超过限额 请联系技术支持工程师增大配额 403 APIG.3139 The number of APP quotas exceeds the maximum allowed limit. 客户端配额数量超过限额 请联系技术支持工程师增大配额 403 APIG.3140 The number of plugins exceeds the maximum allowed limit 插件数量超过限额 请联系技术支持工程师增大配额 403 APIG.3146 The number of ssl certificate exceeds the maximum allowed limit. 证书数量超过限额 请联系技术支持工程师增大配额 403 APIG.3483 The API is deployed and cannot be deleted. 已部署的API无法删除 请撤销部署后删除 403 APIG.3484 The API status does not support deployment. 当前状态API不支持部署 请开发完API后部署 403 APIG.3486 The API status does not support undeployment. 当前状态的自定义后端不支持下线 请部署完API后再操作撤销部署 404 APIC.7302 Instance not found APIC实例不存在 检查实例是否存在，使用正确的实例ID 404 APIG.3001 The API group does not exist. 指定的API分组不存在 检查分组是否存在 404 APIG.3002 The API does not exist. 指定的API不存在 检查API是否存在 404 APIG.3003 The environment does not exist. 指定的环境不存在 检查环境是否存在 404 APIG.3004 The app does not exist. 指定的应用不存在 检查应用是否存在 404 APIG.3005 The request throttling policy does not exist. 指定的流控策略不存在 检查流控策略是否存在 404 APIG.3006 The access control policy does not exist. 指定的ACL策略不存在 检查ACL策略是否存在 404 APIG.3007 The configuration does not exist. 指定的配置不存在 检查配置是否存在 404 APIG.3008 The excluded configuration does not exist. 指定的特殊配置不存在 检查特殊配置是否存在 404 APIG.3009 The app authorization record does not exist. 指定的APP授权信息不存在 检查APP授权是否存在 404 APIG.3010 The access control policy binding record does not exist. 指定的访问控制策略绑定记录不存在 检查ACL策略绑定记录是否存在 404 APIG.3011 The environment variable does not exist. 指定的环境变量不存在 检查环境变量是否存在 404 APIG.3012 The request throttling policy binding record does not exist. 指定的流控策略绑定记录不存在 检查流控策略绑定记录是否存在 404 APIG.3013 The excluded request throttling configuration does not exist. 指定的流控策略特殊配置不存在 检查流控策略特殊配置是否存在 404 APIG.3015 The API publication record does not exist. 指定的API发布记录不存在 检查API发布记录是否存在 404 APIG.3017 The signature key does not exist. 指定的签名密钥不存在 检查签名密钥是否存在 404 APIG.3018 The signature key binding record does not exist. 指定的签名密钥绑定记录不存在 检查签名密钥绑定记录是否存在 404 APIG.3019 The function URN does not exist. 指定的函数URN不存在 检查函数URN是否存在 404 APIG.3020 The URL domain does not exist. 指定的域名不存在 检查分组域名是否存在 404 APIG.3021 The SSL certificate does not exist. 指定的证书不存在 检查SSL证书是否存在 404 APIG.3022 The API version does not exist. 指定的API历史版本不存在 检查API版本是否存在 404 APIG.3023 The VPC channel does not exist. 指定的负载通道不存在 检查负载通道是否存在 404 APIG.3024 The instance does not exist. 指定的弹性云服务器不存在 检查负载通道中是否存在该实例 404 APIG.3025 The certificate does not exist. 指定的证书不存在 检查证书是否存在 404 APIG.3030 The instance does not exist 指定的实例不存在 检查实例是否存在 404 APIG.3064 Roma app and api relation not found. 集成应用与api的关联关系不存在 请联系技术支持工程师协助解决 404 APIG.3065 Roma app authorize relation not found. 集成应用授权关系不存在 请联系技术支持工程师协助解决 404 APIG.3067 The app quota does not exist. 客户端配额不存在 检查客户端配额是否存在 404 APIG.3068 The plugin does not exist. 插件不存在 检查插件是否存在 404 APIG.3069 The plugin binding record does not exist 指定的插件绑定记录不存在 检查插件绑定记录是否存在 404 APIG.3071 The member group does not exist 指定的负载通道服务器组不存在 检查负载通道服务器组是否存在 404 APIG.3081 Authorizer not found 自定义认证不存在 检查自定义认证是否存在 404 APIG.3082 The AppCode does not exist. APP code不存在 检查APP code是否存在 404 APIG.3083 The data source does not exist. 数据源不存在 检查数据源是否存在 404 APIG.3084 The livedata API does not exist 自定义后端API不存在 检查自定义后端API是否存在 404 APIG.3087 The feature configuration does not exist 实例特性配置不存在 检查特性是否存在 404 APIG.3088 Deployment information of the backend API does not exist. 指定的自定义后端API部署记录不存在 检查API部署记录是否存在 404 APIG.3089 The response does not exist 指定的网关响应不存在 检查网关响应是否存在 404 APIG.3090 The Swagger API file does not exist. 指定的Api swagger文档不存在 检查swagger文档是否存在 404 APIG.3091 The APP configuration does not exist 指定的应用配置不存在 检查应用配置是否存在 404 APIG.3092 The ECS does not exist 弹性云服务器不存在 弹性云服务器被删除或者传入的ID错误 404 APIG.3093 The API task does not exist 指定的定时任务不存在 检查定时任务是否存在 404 APIG.3094 Instance task does not exist. 实例异步任务不存在 实例异步任务被删除或者传入的ID错误 404 APIG.9996 The request URL does not exist 请求的地址不存在 请联系技术工程师查看后台日志。 409 APIC.7709 The egress eip has been opened 已开启实例公网出口 关闭实例公网出口后再操作 409 APIC.7711 Public inbound access is enabled for the instance 已开启实例公网入口 请关闭实例公网入口后再操作 409 APIG.3411 The APIs belong to different tenants. 指定的API不属于同一个租户，无法授权 不允许授权给不同租户的API，请更换其他API 409 APIG.3414 The VPC channel is already being used by another API. 指定的负载通道已经被API使用，无法删除 删除负载通道绑定的API后再删除负载通道 409 APIG.3415 The API group cannot be deleted because it contains APIs. 指定的API分组下存在API，无法删除 删除分组下的API后再删除分组 409 APIG.3416 The API cannot be deleted because it has been published. 指定的API已经发布，无法删除 将API下线后再删除API 409 APIG.3418 The environment contains published APIs. 指定的环境下存在已发布的API 将该环境上发布的API下线后再删除环境 409 APIG.3457 Cannot operate configuration of current app. 指定的应用配置名称已存在 修改应用配置名称 409 APIG.3460 The ld api cannot be offlined for binding to an authorizer 自定义后端已被自定义认证使用，不能下线 先删除自定义后端绑定的自定义认证再下线自定义后端 409 APIG.3463 An API with the same path of the current API has already attached with another cors plugin 与当前API请求路径相同的API已经绑定了其他插件 先解绑插件之后再操作 409 APIG.3464 The allow methods of the cors plugin do not contain api method 跨域插件的允许方法不包含当前API的方法 跨域插件的允许方法增加含当前API的方法 409 APIG.3465 The allow methods of the cors plugin do not contain the method of attached API 跨域插件的允许方法不包含绑定的API的方法 不允许操作 409 APIG.3466 An OPTIONS API with the same path of the current API already exists 与当前API请求路径相同，方法为OPTIONS的API已存在 删除当前API请求路径相同，方法为OPTIONS的API 409 APIG.3467 An API with the same path of the current API has already attached with a cors plugin 与当前API请求路径相同的API已经绑定了跨域类型的插件 不需要发布OPTIONS方法的API 409 APIG.3470 The API cannot be operated because it has been used by another API task 指定的API已经被API定时任务使用，无法操作 删除绑定了API的定时任务后再操作 409 APIG.3478 The authorizer has been used by certain APIs. 指定的自定义认证已经被API占用 请解除该自定义认证绑定的所有API后删除 409 APIG.3482 The default API group cannot be deleted. 默认分组不可被删除 不允许操作 409 APIG.3490 The API deployment group ID cannot be changed. 已部署的API绑定的分组不可更改 请撤销部署后修改 409 APIG.3491 The default response cannot be deleted. 默认网关响应不可被删除 不允许操作 409 APIG.3492 The default response name cannot be modified. 默认网关响应名称不可修改 不允许操作 409 APIG.3703 Roma app id of the plugin must be the same with roma app id of the api 插件所属应用需要与API所属应用一致 修改插件所属应用与API所属应用一致 409 APIG.3707 Only published APIs can be bound with plug-ins. 未发布的API不允许绑定插件 将API发布后再绑定到插件 412 APIG.3447 The access control policy has been bound to APIs 指定的访问控制策略绑定了API，无法删除 解绑访问控制策略和API后再删除访问控制策略 412 APIG.3451 The request throttling policy has been bound to APIs. 指定的流控策略绑定了API，无法删除 解绑流控策略绑定的API后再删除流控策略 412 APIG.3456 Cannot operate configuration of current app. 不允许向非集成应用增加配置 更换应用为集成应用 412 APIG.3458 The feature is not supported by current instance. 当前实例不支持该特性 请联系技术支持工程师升级实例 412 APIG.3468 The member group cannot be deleted because it contains members 负载通道服务器组不允许删除 先删除负载通道服务器组下的服务器后再删除负载通道服务器组 412 APIG.3480 The signature key has been bound to APIs. 该签名密钥已绑定API无法删除 请解除该签名密钥绑定的所有API后删除 412 APIG.3481 The app has been bound to APIs. 该APP已绑定了API 解除应用与API的绑定关系后删除应用 412 APIG.3488 The signature has already binded to backend APIs. 该签名密钥已绑定了自定义后端API 请先删除使用了该签名密钥的自定义后端后再删除签名密钥 428 APIG.3462 The plugin has already been attached to APIs 插件已经绑定API 不允许操作 429 APIG.9008 Too many requests. 请求过于频繁，请稍后重试 稍后重试 500 APIC.9999 Internal server error. 系统错误，请联系技术支持工程师 请联系技术支持工程师查看管理面后台日志定位具体错误 500 APIG.3500 Failed to synchronize data to etcd. 配置数据同步失败 请联系技术支持工程师查看管理面后台日志，检查管理面到数据面etcd的网络是否正常 500 APIG.3501 Failed to synchronize data to the instance. 同步数据至实例失败 请联系技术支持工程师查看管理面后台日志，检查管理面到数据面lda的网络是否正常 500 APIG.3503 API testing failed. API测试失败 请联系技术支持工程师查看管理面后台日志，检查管理面到数据面lda的网络是否正常 500 APIG.9002 Invalid function URN. 函数URN校验失败 使用正确的函数URN 500 APIG.9003 Statistics Center request failed. 请求统计中心失败 请联系技术支持工程师查看管理面日志，检查是否请求统计中心网络异常 500 APIG.9004 IAM request failed. 请求IAM认证鉴权失败 请联系技术支持工程师查看管理面日志，检查是否请求IAM网络异常 500 APIG.9005 VPC request failed. 请求VPC服务失败 请联系技术支持工程师查看管理面日志，检查是否请求VPC网络异常 500 APIG.9006 DNS request failed. 请求dns服务失败 请联系技术支持工程师查看管理面日志，检查是否请求DNS网络异常 500 APIG.9007 ELB request failed. 请求ELB服务失败 请联系技术支持工程师查看管理面日志，检查是否请求ELB网络异常 500 APIG.9009 ROMA Quartz request failed. 发送定时任务操作请求失败。 请联系技术支持工程师查看管理面后台日志，排查是否连接ROMA Quartz服务器异常 500 APIG.9013 Synchronize CCMS data failed 同步CCMS数据失败 请联系技术支持工程师协助解决 500 APIG.9999 System error. 系统错误，请联系技术支持工程师 请联系技术支持工程师查看管理面后台日志，检查是否数据库连接异常 父主题： 错误码

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 - File 证书文件 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

响应示例 状态码： 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" }

响应参数 状态码： 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.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.3093", "error_msg" : "App quota c900c5612dbe451bb43cbcc49cfaf2f3 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 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 错误描述

响应示例 状态码： 200 OK { "total" : 2, "size" : 2, "envs" : [ { "create_time" : "2019-02-12T19:42:19.914989Z", "name" : "RELEASE", "remark" : "xxx", "id" : "DEFAULT_ENVIRONMENT_RELEASE_ID" }, { "create_time" : "2020-07-31T06:41:43Z", "name" : "DEV", "remark" : "Development environment", "id" : "7a1ad0c350844ee69479b47df9a881cb" } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "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.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 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 envs Array of EnvInfo objects 本次返回的环境列表 表5 EnvInfo 参数 参数类型 描述 create_time String 创建时间 name String 环境名称 remark String 描述信息 id 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 错误描述

响应示例 状态码： 201 Created { "url_domain" : "www.company.com", "id" : "c5e0d5ba62a34d26ad5c709ae22c1a17", "status" : 3, "min_ssl_version" : "TLSv1.1", "is_http_redirect_to_https" : false, "verified_client_certificate_enabled" : false } 状态码： 400 Bad Request { "error_code" : "APIG.2024", "error_msg" : "Invalid URL domain name" } 状态码： 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.3001", "error_msg" : "API group c77f5e81d9cb4424bf704ef2b0ac7600 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 url_domain String 自定义域名 id String 自定义域名的编号 status Integer CNAME解析状态 1: 未解析 2: 解析中 3: 解析成功 4: 解析失败 min_ssl_version String 支持的最小SSL版本 is_http_redirect_to_https Boolean 是否开启http到https的重定向，false为关闭，true为开启，默认为false 缺省值：false verified_client_certificate_enabled Boolean 是否开启客户端证书校验。只有绑定证书时，该参数才生效。当绑定证书存在trusted_root_ca时，默认开启；当绑定证书不存在trusted_root_ca时，默认关闭。 缺省值：false 状态码： 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 错误描述