更新时间:2022-03-29 GMT+08:00
分享

修改环境

功能介绍

修改指定环境的信息。其中可修改的属性为:name、remark,其它属性不可修改。

调试

您可以在API Explorer中调试该接口。

URI

PUT /v2/{project_id}/apic/instances/{instance_id}/envs/{env_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。

instance_id

String

实例ID

env_id

String

环境的ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

环境的名称,支持英文,数字,下划线,且只能以英文字母开头。

最小长度:3

最大长度:64

remark

String

描述信息

说明:

中文字符必须为UTF-8或者unicode编码。

最大长度:255

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

create_time

String

创建时间

name

String

环境名称

remark

String

描述信息

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

错误描述

请求示例

{
  "name" : "DEV",
  "remark" : "Development environment"
}

响应示例

状态码: 200

OK

{
  "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.3003",
  "error_msg" : "Environment 7a1ad0c350844ee69479b47df9a881cb does not exist"
}

状态码: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品

close