PolarisMesh

创建/更新配置文件并发布

POST

/config/v1/configfiles/createandpub

最后修改时间：2025-03-07 06:58:06

责任人：未设置

从1.18.0版本开始支持

请求参数

Header 参数

X-Polaris-Token

string

可选

鉴权凭据，当OpenAPI接口鉴权开启时必须开启

X-Polaris-Config-Release-Strict

string

可选

是否对配置版本进行校验，开启后不允许相同版本重复发布

示例值:

true

Body 参数application/json

namespace

string

命名空间

必需

group

string

配置分组名称

必需

file_name

string

配置文件名称

必需

format

string

配置文件内容格式

可选

comment

string

配置文件描述

可选

content

string

配置文件内容

可选

不传入则为空字符串

encrypt_algo

string

加密算法

可选

encrypted

boolean

是否开启加密

可选

tags

array [object {2}]

配置文件标签

可选

key

string

标签 key

可选

value

string

标签 value

可选

release_name

string

配置发布版本号

可选

不传入则服务端会自动生成，生成规则为"配置文件名-时间戳-自增ID"

release_description

string

配置发布版本描述

可选

supported_client

string

支持客户端类型

必需

值为0支持sdk拉取，值为1支持agent拉取，值为2支持所有类型拉取

persistent

object

必需

encoding

string

编码模式

必需

path

string

下发路径

必需

postCmd

string

下发命令

必需

示例

{
  "namespace": "default",
  "group": "testGroup",
  "file_name": "application6.yml",
  "format": "yml",
  "comment": "config for test",
  "content": "china: [ 'beijing', 'shanxi', 'hebei', 'neimeng', 'shannxi' ]",
  "encrypt_algo": "magna enim nostrud velit minim",
  "encrypted": true,
  "tags": [
    {
      "key": "tagKey",
      "value": "tagValue"
    },
    {
      "key": "tagKey",
      "value": "tagValue"
    }
  ],
  "release_name": "v1.0.8",
  "release_description": "nisi nulla Lorem Duis eiusmod",
  "supported_client": "velit",
  "persistent": {
    "encoding": "UTF-8",
    "path": "/tmp/cody",
    "postCmd": "echo aaa;\n echo ccc"
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://119.91.66.223:8090/config/v1/configfiles/createandpub' \
--header 'X-Polaris-Token;' \
--header 'X-Polaris-Config-Release-Strict: true' \
--header 'Content-Type: application/json' \
--data-raw '{
    "namespace": "default",
    "group": "testGroup",
    "file_name": "application6.yml",
    "format": "yml",
    "comment": "config for test",
    "content": "china: [ '\''beijing'\'', '\''shanxi'\'', '\''hebei'\'', '\''neimeng'\'', '\''shannxi'\'' ]",
    "encrypt_algo": "magna enim nostrud velit minim",
    "encrypted": true,
    "tags": [
        {
            "key": "tagKey",
            "value": "tagValue"
        },
        {
            "key": "tagKey",
            "value": "tagValue"
        }
    ],
    "release_name": "v1.0.8",
    "release_description": "nisi nulla Lorem Duis eiusmod",
    "supported_client": "velit",
    "persistent": {
        "encoding": "UTF-8",
        "path": "/tmp/cody",
        "postCmd": "echo aaa;\n echo ccc"
    }
}'

返回响应

🟢200成功

application/json

Body

code

integer

状态码

可选

info

string

提示信息

可选

configFileRelease

object

可选

integer

配置发布ID

可选

name

string

配置发布版本

可选

namespace

string

命名空间

可选

group

string

配置分组

可选

file_name

string

配置文件名

可选

active

boolean

是否生效

可选

示例

{
  "code": 200000,
  "info": "execute success",
  "configFileRelease": {
    "id": 8,
    "name": "v1.0.8",
    "namespace": "default",
    "group": "testGroup",
    "fileName": "application6.yml",
    "md5": "40d4c5ceba52da868dae50c32c351cca"
  }
}

修改于 2025-03-07 06:58:06

批量删除配置文件

查询某个配置分组下的所有配置文件