更新时间:2024-12-16 GMT+08:00

创建配置文件

功能介绍

此API用于创建配置文件。

URI

POST /v3/{project_id}/cas/configs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID。获取方法,请参考获取项目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。

name

String

配置文件名称。

为长度2到64个字符的字符串,可以包含英文字母、数字、下划线(_)或中划线(-),以英文字母开头、英文字母或者数字结尾。

content

String

配置文件内容。

description

String

配置文件描述,为不超过128个字符的字符串。

type

String

配置文件格式:

  • yaml
  • properties

sensitive

Boolean

配置文件内容是否加密:

  • true,加密。
  • false,不加密。

响应消息

表4 响应参数

参数

参数类型

描述

id

String

配置文件ID。

name

String

配置文件名称。

description

String

配置描述。

creator

String

创建人。

project_id

String

项目ID。

type

String

配置文件格式:

  • yaml
  • properties

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。

请求示例

创建名为test-config的配置文件,不加密,文件格式为properties。

{
	"config_group_id": "f3e6d5b4-4d7d-4009-b806-22cfed2ac6ea",
	"name": "test-config",
	"description": "",
	"type": "properties",
	"content": "test-key = test-value",
	"sensitive": false
}

响应示例

{
	"id": "d5821100-9a82-4d1c-9468-fc6b2b9ccdad",
	"config_group_id": "f3e6d5b4-4d7d-4009-b806-22cfed2ac6ea",
	"name": "test-config",
	"description": "",
	"type": "properties",
	"content": "testkey = testvalue",
	"version": "v1",
	"project_id": "2cfeefc3e4c54a5aa7548b8350e638d7",
	"sensitive": false,
	"create_time": 1717485580152,
	"update_time": 1717485580152,
	"components": [],
	"creator": "ss-test"
}

状态码

状态码

描述

200

操作成功。

400

错误的请求。

404

请求对象不存在。

500

内部错误。

错误码

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