环境变量管理-华为云

应用与数据集成平台 ROMA CONNECT-新建变量:响应示例

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

应用与数据集成平台 ROMA CONNECT 环境变量管理

应用与数据集成平台 ROMA CONNECT-新建变量:响应参数

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

应用与数据集成平台 ROMA CONNECT 环境变量管理

应用与数据集成平台 ROMA CONNECT-新建变量:功能介绍

功能介绍将API发布到不同的环境后，对于不同的环境，可能会有不同的环境变量，比如，API的服务部署地址，请求的版本号等。用户可以定义不同的环境变量，用户在定义API时，在API的定义中使用这些变量，当调用API时，服务集成会将这些变量替换成真实的变量值，以达到不同环境的区分效果。环境变量定义在API分组上，该分组下的所有API都可以使用这些变量。 1.环境变量的变量名称必须保持唯一，即一个分组在同一个环境上不能有两个同名的变量 2.环境变量区分大小写，即变量ABC与变量abc是两个不同的变量 3.设置了环境变量后，使用到该变量的API的调试功能将不可使用。 4.定义了环境变量后，使用到环境变量的地方应该以对称的#标识环境变量，当API发布到相应的环境后，会对环境变量的值进行替换，如：定义的API的URL为：https://#address#:8080，环境变量address在RELEASE环境上的值为：192.168.1.5，则API发布到RELEASE环境后的真实的URL为：https://192.168.1.5:8080。

应用与数据集成平台 ROMA CONNECT 环境变量管理

应用与数据集成平台 ROMA CONNECT-新建变量:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。表3 请求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编码。

应用与数据集成平台 ROMA CONNECT 环境变量管理

API网关 APIG-查询变量列表:响应示例

响应示例状态码： 200 OK { "variables" : [ { "variable_value" : "8080", "env_id" : "cca3616af3684b329064b2a631cb3eeb", "group_id" : "73c58022f20d495aa18885d718647f09", "id" : "09ab8135722440b9bf5d107f2a09d409", "variable_name" : "port" }, { "variable_value" : "192.168.1.5", "env_id" : "7a1ad0c350844ee69479b47df9a881cb", "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600", "id" : "25054838a624400bbf2267cf5b3a3f70", "variable_name" : "address" } ], "total" : 2, "size" : 2 } 状态码： 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" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

API网关 APIG 专享版-环境变量管理

API网关 APIG-查询变量列表:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 variables Array of EnvVariableInfo objects 本次返回的环境变量列表表5 EnvVariableInfo 参数参数类型描述 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 表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 错误描述状态码： 500 表9 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述

API网关 APIG 专享版-环境变量管理

API网关 APIG-查询变量列表:URI

URI GET /v2/{project_id}/apigw/instances/{instance_id}/env-variables 表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 group_id 是 String API分组编号 env_id 否 String 环境编号 variable_name 否 String 变量名 precise_search 否 String 指定需要精确匹配查找的参数名称，目前仅支持variable_name

API网关 APIG 专享版-环境变量管理

API网关 APIG-新建变量:响应示例

响应示例状态码： 201 Created { "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: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.3003", "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" }

API网关 APIG 专享版-环境变量管理

API网关 APIG-新建变量:功能介绍

功能介绍将API发布到不同的环境后，对于不同的环境，可能会有不同的环境变量，比如，API的服务部署地址，请求的版本号等。用户可以定义不同的环境变量，用户在定义API时，在API的定义中使用这些变量，当调用API时，API网关会将这些变量替换成真实的变量值，以达到不同环境的区分效果。环境变量定义在API分组上，该分组下的所有API都可以使用这些变量。环境变量的变量名称必须保持唯一，即一个分组在同一个环境上不能有两个同名的变量。环境变量区分大小写，即变量ABC与变量abc是两个不同的变量。设置了环境变量后，使用到该变量的API的调试功能将不可使用。定义了环境变量后，使用到环境变量的地方应该以对称的#标识环境变量，当API发布到相应的环境后，会对环境变量的值进行替换，如：定义的API的URL为：https://#address#:8080，环境变量address在RELEASE环境上的值为：192.168.1.5，则API发布到RELEASE环境后的真实的URL为：https://192.168.1.5:8080。

API网关 APIG 专享版-环境变量管理

API网关 APIG-新建变量:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。表3 请求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编码。

API网关 APIG 专享版-环境变量管理

API网关 APIG-新建变量:响应参数

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

API网关 APIG 专享版-环境变量管理

API网关 APIG-查看变量详情:响应消息

响应消息表3 参数说明参数类型说明 id String 环境变量的编号 env_id String 环境编号 group_id String API分组编号 variable_name String 变量名 variable_value String 变量值响应消息样例： {"id": "104185e5-3e8f-4c63-a7e5-ef4117bf870c","env_id": "cca3616a-f368-4b32-9064-b2a631cb3eeb","group_id": "73c58022-f20d-495a-a188-85d718647f09","variable_name": "address","variable_value": "192.168.1.5"}

API网关 APIG 环境变量管理

API网关 APIG-对象模型

对象模型本节介绍环境变量的对象模型，如下表所示： “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。表1 环境变量对象模型参数类型说明操作类型是否必选 id String 环境变量编号 R - env_id String 环境编号 CR 是 group_id String API分组编号 CR 是 variable_name String 变量名 CR 是 variable_value String 变量值 CR 是父主题：环境变量管理（待下线）

API网关 APIG 环境变量管理（待下线）

云服务器内容精选

环境变量管理

7*24

备案

专业服务

退订

建议反馈

售前咨询热线