수정¶
POST /api/v1/field_cfg/{field_uuid}/modify
개요¶
필드 관리를 수정합니다.
경로 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| field_uuid | string | Y | 필드 UUID |
Body 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| name | string | Y | 필드 이름. 동일한 필드 소스(fieldSource)에서 필드 이름은 중복될 수 없습니다. 빈 값 허용: False 빈 문자열 허용: False 최대 길이: 256 |
| alias | string | 필드 별칭 빈 값 허용: False 빈 문자열 허용: False 최대 길이: 256 |
|
| aliasI18n | object | 필드 별칭 다국어. key는 zh/en/zh-hant/id/ja/ko를 지원합니다. 빈 값 허용: False |
|
| unit | string | 단위 정보. fieldType이 string인 경우 단위는 빈 값으로 설정됩니다. 빈 값 허용: False 최대 길이: 256 빈 문자열 허용: True |
|
| fieldType | string | 필드 유형 예시: time 빈 값 허용: False 빈 문자열 허용: True 선택 값: ['text', 'int', 'float', 'boolean', 'string', 'long'] |
|
| category | string | 속성 분류. 시스템 필드(기본 선택), 비즈니스 필드, 기타가 포함됩니다. 예시: system 빈 값 허용: False 빈 문자열 허용: False 선택 값: ['system', 'business', 'other'] |
|
| fieldSource | string | 필드 소스 예시: time 빈 값 허용: False 빈 문자열 허용: True 선택 값: ['logging', 'object', 'custom_object', 'keyevent', 'tracing', 'rum', 'security', 'network', 'billing'] |
|
| desc | string | 필드 설명 정보 예시: 호스트 이름 빈 값 허용: False 빈 문자열 허용: True 최대 길이: 3000 |
|
| descI18n | object | 필드 설명 다국어. key는 zh/en/zh-hant/id/ja/ko를 지원합니다. 빈 값 허용: False |
|
| coverInner | boolean | 추가할 필드 이름이 시스템 내장 필드와 동일한 경우 덮어쓸지 여부. true는 덮어쓰기, false는 덮어쓰지 않습니다. 예시: True 빈 값 허용: False |
파라미터 추가 설명¶
파라미터 설명: 추가 인터페이스 참조
## 요청 예시
```shell
curl 'https://openapi.guance.com/api/v1/field_cfg/field_0f95016f7254494da088d878ce586477/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Accept: application/json, text/plain, */*' \
-H 'Accept-Language: zh' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"name":"test_load","alias":"as_load","fieldType":"int","desc":"modify_test","fieldSource":"","unit":"custom/[\"time\",\"ns\"]","coverInner":false}' \
--compressed
응답¶
{"code":200,"content":{"alias":"as_load","aliasEn":"","createAt":1735628856,"creator":"wsak_73a0ad39c352477a9417f633670a0908","declaration":{"business":"","organization":"default_private_organization"},"deleteAt":-1,"desc":"modify_test","descEn":"","fieldSource":"","fieldType":"int","id":1791,"name":"test_load","status":0,"sysField":0,"unit":"custom/[\\"time\\",\\"ns\\"]","updateAt":1735635730.899186,"updator":"wsak_73a0ad39c352477a9417f633670a0908","uuid":"field_0f95016f7254494da088d878ce586477","workspaceUUID":"wksp_05adf2282d0d47f8b79e70547e939617"},"errorCode":"","message":"","success":true,"traceId":"TRACE-D11D56A9-BC80-48D4-903C-550D248204BD"}