変更¶
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 | フィールドエイリアスの多言語設定。キーに 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 | 属性カテゴリ。システムフィールド（デフォルト選択）、ビジネスフィールド、その他を含む。 空を許可: 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 | フィールド説明の多言語設定。キーに 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"}