목록¶
GET /api/v1/field_cfg/list
개요¶
필드 관리 목록을 조회합니다. 내장 필드 및 사용자 정의 필드 구성을 포함합니다.
Query 요청 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| search | string | 필드 이름 검색 빈 값 허용: False |
|
| pageIndex | integer | 페이지 번호 빈 값 허용: False 예시: 10 $minValue: 1 |
|
| pageSize | integer | 페이지당 반환 개수 빈 값 허용: False 예시: 10 $minValue: 1 $maxValue: 1000 |
파라미터 추가 설명¶
데이터 설명
- 관련 응답 필드 설명
| 파라미터명 | type | 설명 |
|---|---|---|
| sysField | string | 내장 필드 여부, 1: 내장, 0: 사용자 정의. 내장 필드는 수정 불가 |
요청 예시¶
curl 'https://openapi.guance.com/api/v1/field_cfg/list?pageIndex=1&pageSize=5' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed
응답¶
{
"code": 200,
"content": {
"data": [
{
"alias": "主机",
"aliasEn": "Host",
"aliasI18n": {
"zh": "主机",
"en": "Host",
"zh-hant": "主機",
"id": "Host",
"ja": "",
"ko": ""
},
"createAt": 1735628856,
"creator": "wsak_73a0ad39c352477a9417f633670a0908",
"creatorInfo": {
"email": "wsak_73a0ad39c352477a9417f633670a0908",
"iconUrl": "",
"mobile": "",
"name": "jon test",
"status": 0,
"username": "jon test",
"uuid": "wsak_73a0ad39c352477a9417f633670a0908",
"wsAccountStatus": 0
},
"desc": "主机名称",
"descEn": "Host name",
"descI18n": {
"zh": "主机名称",
"en": "Host name",
"zh-hant": "主機名稱",
"id": "Nama host",
"ja": "",
"ko": ""
},
"fieldSource": "logging",
"fieldType": "string",
"name": "host",
"sysField": 0,
"unit": "",
"updateAt": 1735635731,
"updator": "wsak_73a0ad39c352477a9417f633670a0908",
"updatorInfo": {},
"uuid": "field_0f95016f7254494da088d878ce586477"
}
],
"declaration": {
"business": "",
"organization": "default_private_organization"
}
},
"errorCode": "",
"message": "",
"pageInfo": {
"count": 1,
"pageIndex": 1,
"pageSize": 5,
"totalCount": 1
},
"success": true,
"traceId": "TRACE-867A8BDB-A853-4FDD-BE9E-8E528FCB9C35"
}