一覧¶
GET /api/v1/field_cfg/list
概要¶
現在のワークスペースのカスタムフィールド設定と、表示可能な組み込みフィールド設定をページングして一覧表示します。
呼び出し前の準備と使用手順¶
対象ワークスペースの API Key を使用します。この設定では、既存フィールドに表示用の別名、説明、単位、分類を追加します。収集フィールドの作成、実際のデータ型の変更、履歴データのバックフィルは行いません。フィールドソースが同じで、名前の大文字と小文字が完全に一致するカスタム設定は重複できません。ソースが異なる場合は同じ名前を使用できます。
名前または別名のキーワードで検索し、ページ単位で取得します。最初にカスタムフィールドを返し、次に、同じソースと同じ名前のカスタム設定で上書きされていない組み込みフィールドを連結します。それぞれ名前順に並べ替えられ、全体で混在して並べ替えられることはありません。search は先頭と末尾の空白を除去します。データベースの LIKE における % と _ は引き続きワイルドカードとして解釈されます。Accept-Language は表示言語を選択します(zh/en/zh-Hant/id/ja/ko)。省略した場合はサイトのデフォルト言語を使用します。中国語では名前/中国語の別名、英語では名前/英語の別名を検索します。その他の4言語では、現在の言語の別名/説明に加えて、中国語と英語の別名も検索します。一覧はキャッシュを強制せず、空のページが返されることも正常な結果です。2種類のフィールドをそれぞれ検索してから上書き関係を計算します。search に一致しないカスタム上書き項目は非表示の対象になりません。完全な上書き関係を確認する場合は、先に search をクリアしてください。coverInner は表示上のヒントにすぎません。ソースが異なる同名の行にも true が付く場合があるため、このキーだけで判断することはできません。
一覧の desc/alias は言語ごとのフォールバックで表示されます(zh→en、en→zh、zh-hant→zh→en、その他→en→zh)。多言語マッピングは元の値を保持します。変更前は完全な設定を優先的に保持してください。sysField=1 の組み込み行は参考情報にすぎません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| Accept-Language | string | 任意。一覧の表示と検索に影響しますが、保存された多言語マッピングは変更しません。 例: zh取得または入力方法: サポートされているリクエスト言語を選択します。省略した場合はサイトのデフォルト言語を使用します。 |
|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| pageIndex | integer | 任意。デフォルトは 1、最小値は 1。 null の許可: False $minValue: 1 例: 1取得または入力方法: 最初のリクエストでは 1 を指定し、pageInfo.totalCount を参照してページを切り替えます。 |
|
| pageSize | integer | 任意。コントローラーのデフォルトは 100、上限は 1000。 null の許可: False $maxValue: 1000 $minValue: 1 例: 20取得または入力方法: クライアントの処理能力に応じて 1~1000 の範囲で選択します。 |
|
| search | string | 任意のあいまい検索です。フィールドソースによるフィルタではありません。 null の許可: False 例: host取得または入力方法: 実際の名前または別名のキーワードを指定します。省略または空文字列の場合はすべてを検索します。 |
パラメータの補足説明¶
フィールド管理設定の優先順位: 同じソースと同じ名前の場合、カスタム設定が組み込み設定を上書きします。詳細と変更には設定 UUID を使用する必要があります。実際の収集フィールド名は引き続き name です。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/field_cfg/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode search=host \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=20
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.data | array<object> | 現在のページのフィールド設定。カスタム設定が先に続き、上書きされていない組み込み設定が後に続きます。それぞれ名前順に並べ替えられます。 |
| content.declaration | object | ワークスペースの共通宣言。 |
| content.data[].uuid | string | フィールド設定 UUID。後続の操作ではこの値を使用します。実際のフィールド名ではありません。 |
| content.data[].name | string | 実際のフィールド名。大文字と小文字を区別します。 |
| content.data[].alias | string | 別名。一覧ではリクエスト言語に従って表示され、詳細/作成/変更では互換フィールドの値が保持されます。 |
| content.data[].aliasEn | string | 互換用の英語別名。中国語にフォールバックする場合があります。 |
| content.data[].aliasI18n | object | 6言語の元の別名マッピング。言語値が空でも、表示が必ず空になるわけではありません。 |
| content.data[].desc | string | 説明。一覧ではリクエスト言語に従って表示され、それ以外のレスポンスでは互換フィールドの値になります。 |
| content.data[].descEn | string | 互換用の英語説明。中国語にフォールバックする場合があります。 |
| content.data[].descI18n | object | 6言語の元の説明マッピング。 |
| content.data[].fieldType | string | 設定上のデータ型。実際の収集フィールドの型は変更しません。履歴の組み込みレコードには、新規作成時の Body 以外の値が含まれる場合があります。 |
| content.data[].fieldSource | string | 適用対象のソース。空文字列は汎用設定を表します。 |
| content.data[].unit | string | 表示単位。fieldType=string で保存する場合は強制的に空になります。 |
| content.data[].sysField | integer | 1 は組み込み、0 はカスタム。組み込み設定はこの API では変更/削除できません。 |
| content.data[].category | string | system はシステムフィールド、business はビジネスフィールド、other はその他。古いレコードでは空の場合があります。 |
| content.data[].creator | string | 作成者。API Key またはシステム ID の場合があります。 |
| content.data[].updator | string | 更新者。未更新の場合は空文字列です。 |
| content.data[].createAt | integer | 作成日時。Unix 秒。 |
| content.data[].updateAt | integer | 更新日時。Unix 秒。未更新の場合は -1 になることがあります。 |
| content.data[].aliasI18n.zh | string | zh 言語の元の別名。提供されない場合は通常空です。一覧表示では言語に応じたフォールバックが行われます。 |
| content.data[].aliasI18n.en | string | en 言語の元の別名。提供されない場合は通常空です。一覧表示では言語に応じたフォールバックが行われます。 |
| content.data[].aliasI18n.zh-hant | string | zh-hant 言語の元の別名。提供されない場合は通常空です。一覧表示では言語に応じたフォールバックが行われます。 |
| content.data[].aliasI18n.id | string | id 言語の元の別名。提供されない場合は通常空です。一覧表示では言語に応じたフォールバックが行われます。 |
| content.data[].aliasI18n.ja | string | ja 言語の元の別名。提供されない場合は通常空です。一覧表示では言語に応じたフォールバックが行われます。 |
| content.data[].aliasI18n.ko | string | ko 言語の元の別名。提供されない場合は通常空です。一覧表示では言語に応じたフォールバックが行われます。 |
| content.data[].descI18n.zh | string | zh 言語の元の説明。提供されない場合は通常空です。一覧表示では言語に応じたフォールバックが行われます。 |
| content.data[].descI18n.en | string | en 言語の元の説明。提供されない場合は通常空です。一覧表示では言語に応じたフォールバックが行われます。 |
| content.data[].descI18n.zh-hant | string | zh-hant 言語の元の説明。提供されない場合は通常空です。一覧表示では言語に応じたフォールバックが行われます。 |
| content.data[].descI18n.id | string | id 言語の元の説明。提供されない場合は通常空です。一覧表示では言語に応じたフォールバックが行われます。 |
| content.data[].descI18n.ja | string | ja 言語の元の説明。提供されない場合は通常空です。一覧表示では言語に応じたフォールバックが行われます。 |
| content.data[].descI18n.ko | string | ko 言語の元の説明。提供されない場合は通常空です。一覧表示では言語に応じたフォールバックが行われます。 |
| content.data[].coverInner | boolean | 任意の表示ヒントです。同じソースでの上書きを単独で証明するには不十分です。計算時には名前のみを記録するため、同じ名前でソースが異なるカスタム行にも true が付く場合があります。search をクリアし、fieldSource と name を組み合わせて確認してください。他の行にはこのキーが存在しない場合があります。 |
| content.data[].creatorInfo | object | 作成者情報。見つからない場合は {} で、システム ID の場合は一部のキーのみが返されることがあります。 |
| content.data[].creatorInfo.uuid | string | 作成者 UUID。実際のレスポンスに従います。 |
| content.data[].creatorInfo.status | integer | 作成者ステータス。実際のレスポンスに従います。 |
| content.data[].creatorInfo.wsAccountStatus | integer | ワークスペースメンバーのステータス。実際のレスポンスに従います。 |
| content.data[].creatorInfo.username | string | ユーザー名または Key 名。実際のレスポンスに従います。 |
| content.data[].creatorInfo.name | string | 名前。実際のレスポンスに従います。 |
| content.data[].creatorInfo.email | string | メールアドレスまたは Key 識別子。メールアドレス形式であることは保証されません。実際のレスポンスに従います。 |
| content.data[].creatorInfo.mobile | string | 携帯電話番号。空の場合があります。実際のレスポンスに従います。 |
| content.data[].creatorInfo.countryCode | string | 国番号。省略可能です。実際のレスポンスに従います。 |
| content.data[].creatorInfo.iconUrl | string | アイコン URL。省略可能です。実際のレスポンスに従います。 |
| content.data[].creatorInfo.acntWsNickname | string | ワークスペースのニックネーム。省略可能です。実際のレスポンスに従います。 |
| content.data[].updatorInfo | object | 更新者情報。見つからない場合は {} で、システム ID の場合は一部のキーのみが返されることがあります。 |
| content.data[].updatorInfo.uuid | string | 更新者 UUID。実際のレスポンスに従います。 |
| content.data[].updatorInfo.status | integer | 更新者ステータス。実際のレスポンスに従います。 |
| content.data[].updatorInfo.wsAccountStatus | integer | ワークスペースメンバーのステータス。実際のレスポンスに従います。 |
| content.data[].updatorInfo.username | string | ユーザー名または Key 名。実際のレスポンスに従います。 |
| content.data[].updatorInfo.name | string | 名前。実際のレスポンスに従います。 |
| content.data[].updatorInfo.email | string | メールアドレスまたは Key 識別子。メールアドレス形式であることは保証されません。実際のレスポンスに従います。 |
| content.data[].updatorInfo.mobile | string | 携帯電話番号。空の場合があります。実際のレスポンスに従います。 |
| content.data[].updatorInfo.countryCode | string | 国番号。省略可能です。実際のレスポンスに従います。 |
| content.data[].updatorInfo.iconUrl | string | アイコン URL。省略可能です。実際のレスポンスに従います。 |
| content.data[].updatorInfo.acntWsNickname | string | ワークスペースのニックネーム。省略可能です。実際のレスポンスに従います。 |
| pageInfo.pageIndex | integer | 現在のページ。1 から始まります。 |
| pageInfo.pageSize | integer | 1 ページあたりの件数。 |
| pageInfo.count | integer | 現在のページの件数。 |
| pageInfo.totalCount | integer | マージおよび組み込みによる上書き後の総件数。 |
{
"code": 200,
"content": {
"data": [
{
"uuid": "field_example",
"name": "host",
"alias": "主机",
"aliasEn": "Host",
"aliasI18n": {
"zh": "主机",
"en": "Host",
"zh-hant": "主機",
"id": "",
"ja": "",
"ko": ""
},
"desc": "主机名称",
"descEn": "Host name",
"descI18n": {
"zh": "主机名称",
"en": "Host name",
"zh-hant": "主機名稱",
"id": "",
"ja": "",
"ko": ""
},
"fieldType": "string",
"fieldSource": "logging",
"category": "business",
"unit": "",
"sysField": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"creatorInfo": {},
"updatorInfo": {}
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 20,
"count": 1,
"totalCount": 1
}
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーの詳細は共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータを使用した場合、またはパラメータが規則に違反した場合 | パラメータの解析に失敗しました | Query パラメータ表と例を確認してください。 |
| 500 | ft.InternalServerError | クエリ、ID 情報の補完、またはレスポンスのフォーマットに失敗しました | 内部エラー | traceId を保持して再試行してください。失敗が続く場合は管理者に連絡してください。 |