コンテンツにスキップ

一覧表示¶

GET /api/v1/field_cfg/list

概要¶

フィールド管理の一覧を取得します。組み込みフィールドとカスタムフィールドの設定を含みます。

Query リクエストパラメータ¶

パラメータ名	型	必須	説明
search	string		フィールド名の検索空の場合は許可されません: False
pageIndex	integer		ページ番号空の場合は許可されません: False 例: 10 $minValue: 1
pageSize	integer		1ページあたりの返却件数空の場合は許可されません: 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"
}