修改应用配置信息
功能介绍
通过此API修改应用配置信息。
应用配置主要是指应用的公共环境变量,该应用下部署的组件可以继承。
URI
PUT /v2/{project_id}/cas/applications/{application_id}/configuration
请求消息
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
Content-Type |
是 |
String |
消息体的类型(格式),默认取值为“application/json;charset=utf8”。 |
X-Auth-Token |
是 |
String |
调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
environment_id |
是 |
String |
环境ID,可以通过调用获取所有环境找到对应的环境获取。 |
configuration |
是 |
Object |
应用配置信息,如公共环境变量,请参考表4。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
环境变量名称。 由字母、数字、下划线、中划线或者点号组成,不能以数字开头,且长度为1-64个字符。 |
value |
是 |
String |
环境变量取值。 |
此接口的请求参数configuration中env变量会全量覆盖应用本身已有的环境变量配置,使用时请根据是新增还是替换环境变量的场景设置此参数。
响应消息
参数 |
参数类型 |
描述 |
---|---|---|
application_id |
String |
应用ID。 |
environment_id |
String |
环境ID。 |
configuration |
Object |
应用配置信息,请参考表7。 |
请求示例
修改应用对应环境id为0fa75dfe-0d32-4bc1-848b-8008cf3f2567的环境变量配置:名为app-env、值为env的环境变量。
{ "environment_id": "0fa75dfe-0d32-4bc1-848b-8008cf3f2567", "configuration": { "env": [ { "name": "app-env", "value": "env" } ] } }
响应示例
{ "application_id": "06cf2fda-af45-44b4-9e22-6294c4804515", "environment_id": "0fa75dfe-0d32-4bc1-848b-8008cf3f2567", "configuration": { "env": [ { "name": "app-env", "value": "env" } ] } }
状态码
状态码 |
描述 |
---|---|
200 |
操作成功。 |
400 |
错误的请求。 |
404 |
请求对象不存在。 |
500 |
内部错误。 |
错误码
错误码格式为:SVCSTG.00100.[Error_ID],例如:SVCSTG.00100400。错误码说明请参考ServiceStage错误码。