Modify Channel Information¶
POST /api/v1/channel/{channel_uuid}/modify
Overview¶
Route Parameters¶
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| channel_uuid | string | Y | Channel UUID |
Body Request Parameters¶
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| name | string | Channel name Example: Channel No.1 Can be empty: False Maximum length: 256 |
|
| description | string | Channel description Example: CUSTOM Can be empty: False Can be an empty string: True Maximum length: 256 |
|
| notifyTarget | array | List of notification target UUIDs Example: [] Can be empty: False |
|
| notifyUpgradeCfg | json | Rule configuration Can be empty: False |
|
| notifyUpgradeCfg.triggerTime | integer | Y | After how many seconds to trigger upgrade notification, unit s Example: simpleCheck Can be empty: False |
| notifyUpgradeCfg.notifyTarget | array | Y | List of upgrade notification target UUIDs Example: [] Can be empty: False |
Additional Parameter Notes¶
Request Example¶
curl 'https://openapi.guance.com/api/v1/channel/chan_xxxx32/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"description":"dasdgahjsdgashjgdhajsgdasjhgdhjasgdajhsgzxvchv @sadddddd","notifyTarget":["notify_xxxx32"]}' \
--compressed
Response¶
{
"code": 200,
"content": {
"createAt": 1680257540,
"creator": "acnt_xxxx32",
"deleteAt": 1681968404,
"description": "dasdgahjsdgashjgdhajsgdasjhgdhjasgdajhsgzxvchv @sadddddd",
"id": 33,
"name": "default",
"notifyTarget": [
"notify_xxxx32"
],
"status": 0,
"updateAt": 1686397319.9216194,
"updator": "acnt_xxxx32",
"uuid": "chan_xxxx32",
"workspaceUUID": "wksp_xxxx32"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "14871204483417928076"
}