PolarisMesh

创建配置文件

POST

/config/v1/configfiles

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

责任人：未设置

请求参数

Header 参数

X-Polaris-Token

string

可选

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

Body 参数application/json

namespace

string

命名空间

必需

group

string

配置分组名称

必需

name

string

配置文件名称

必需

format

string

配置文件内容格式

可选

comment

string

配置文件描述

可选

content

string

配置文件内容

可选

不传入则为空字符串

encrypt_algo

string

加密算法

可选

encrypted

boolean

是否开启加密，默认不开启

可选

tags

array [object {2}]

配置文件标签

可选

key

string

标签 key

可选

value

string

标签 value

可选

supported_client

string

支持客户端类型

可选

CLIENT_SDK = 0; // 配置文件仅能被SDK拉取 CLIENT_AGENT = 1; // 配置文件仅能被Agent拉取 CLIENT_ALL = 2; // 配置文件可以被SDK及Agent同时拉取

persistent

object

可选

encoding

string

编码模式

必需

path

string

下发路径

必需

postCmd

string

下发命令

必需

示例

{
    "namespace": "default",
    "group": "GROUP-123",
    "name": "application.yaml",
    "content": "coffees: [ \"Latte\", \"Cappuccino\", \"Espresso\"]",
    "comment": "config for test",
    "format": "yaml",
    "tags": [
        {
            "key": "key1",
            "value": "value1"
        }
    ],
    "supported_client": "CLIENT_AGENT",
    "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' \
--header 'X-Polaris-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "namespace": "default",
    "group": "GROUP-123",
    "name": "application.yaml",
    "content": "coffees: [ \"Latte\", \"Cappuccino\", \"Espresso\"]",
    "comment": "config for test",
    "format": "yaml",
    "tags": [
        {
            "key": "key1",
            "value": "value1"
        }
    ],
    "supported_client": "CLIENT_AGENT",
    "persistent": {
    "encoding": "UTF-8",
    "path": "/tmp/cody",
    "postCmd": "echo aaa;\n echo ccc"
    }
}'

返回响应

🟢200成功

application/json

Body

code

integer

状态码

可选

info

string

提示信息

可选

configFile

object

配置文件

可选

integer

配置文件ID

可选

namespace

string

命名空间

可选

group

string

配置分组名称

可选

name

string

配置文件名称

可选

format

string

配置文件内容格式

可选

comment

string

配置文件描述

可选

content

string

配置文件内容

可选

tags

array [object {2}]

配置文件标签

可选

supported_client

string

支持客户端类型

可选

CLIENT_SDK = 0; // 配置文件仅能被SDK拉取 CLIENT_AGENT = 1; // 配置文件仅能被Agent拉取 CLIENT_ALL = 2; // 配置文件可以被SDK及Agent同时拉取

persistent

object

可选

示例

{
    "code": 200000,
    "info": "execute success",
    "configFile": {
        "id": 1,
        "name": "application.yaml",
        "namespace": "default",
        "group": "GROUP-123",
        "content": "coffees: [ \"Latte\", \"Cappuccino\", \"Espresso\"]",
        "format": "yaml",
        "comment": "config for test",
        "tags": [
            {
                "key": "key1",
                "value": "value1"
            }
        ],
        "supported_client": "CLIENT_AGENT",
        "persistent": {
            "encoding": "UTF-8",
            "path": "/tmp/cody",
            "postCmd": "echo aaa;\n echo ccc"
        }
    }
}

修改于 2025-03-07 07:07:43

获取配置分组列表

更新配置文件