文档首页/ 应用管理与运维平台 ServiceStage/ API参考/ 应用管理API（v3版本）/ 配置管理/ 根据配置文件ID修改配置文件
更新时间：2024-12-04 GMT+08:00
查看PDF
分享

根据配置文件ID修改配置文件

功能介绍

此API用于通过配置文件ID修改配置文件。

URI

PUT /v3/{project_id}/cas/configs/{config_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID。获取方法，请参考获取项目ID。

config_id

是

String

配置文件ID。获取方法，请参考获取配置文件信息。

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

消息体的类型（格式），默认取值为“application/json;charset=utf8”。

X-Auth-Token

是

String

调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考认证鉴权。
表3 请求Body参数

参数

是否必选

参数类型

描述

config_group_id

是

String

配置分组ID。

content

是

String

配置文件内容。

type

是

String

配置文件格式。

description

否

String

配置文件描述。

sensitive

否

Boolean

配置文件内容是否加密：

  • true，加密。
  • false，不加密。

响应消息

表4 响应参数

参数

参数类型

描述

config_group_id

String

配置分组ID。

id

String

配置文件ID。

name

String

配置文件名称。

description

String

配置文件描述。

creator

String

创建人。

type

String

配置文件类型：

  • yaml
  • properties

content

String

配置文件内容。

version

String

配置文件版本号。

project_id

String

项目ID。

sensitive

Boolean

配置文件内容是否加密：

  • true，加密。
  • false，不加密。

components

Array of objects

配置文件绑定的组件列表，请参考表5。

create_time

Integer

创建时间。

update_time

Integer

修改时间。
表5 components

参数

参数类型

描述

application_id

String

应用ID。

component_id

String

组件ID。

component_name

String

组件名称。

environment_id

String

环境ID。

请求示例

修改配置文件的分组ID为4808b50d-d7f3-401b-9175-968cb4f9892b、配置文件类型为properties、文件内容为testKey = testModify、不加密文件内容。

{
	"config_group_id": "4808b50d-d7f3-401b-9175-968cb4f9892b",
	"description": "",
	"type": "properties",
	"content": "testKey = testModify",
	"sensitive": false
}

响应示例

{
	"id": "f5a52d93-1587-45cf-b8fe-5c7f204b98d1",
	"config_group_id": "4808b50d-d7f3-401b-9175-968cb4f9892b",
	"name": "test-config1",
	"description": "",
	"type": "properties",
	"content": "testKey = testModify",
	"version": "v2",
	"project_id": "2cfeefc3e4c54a5aa7548b8350e638d7",
	"sensitive": false,
	"create_time": 1717486892611,
	"update_time": 1717491574202,
	"components": [{
		"application_id": "8a3be48a-6401-4e8c-bbce-033745252227",
		"component_id": "4b611997-4acd-4538-a06b-32fd2475e057",
		"component_name": "component-test1",
		"environment_id": "d2d7180c-7739-4cbb-bd8e-0911ba31cf51"
	}],
	"creator": "ss-test"
}

状态码

状态码

描述

204

操作成功。

400

错误的请求。

404

请求对象不存在。

500

内部错误。

错误码

错误码格式为：SVCSTG.00100.[Error_ID]，例如：SVCSTG.00100400。错误码说明请参考ServiceStage错误码。

父主题： 配置管理

相关文档