変更¶
POST /api/v1/objc_cfg/{objc_name}/modify
概要¶
リソースカタログの設定を変更します
ルートパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| objc_name | string | Y | リソースカタログ設定名 |
Body リクエストパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| sourceType | string | Y | ソースタイプ、デフォルト値はcustom_object空を許可しない: False 選択可能な値: ['object', 'custom_object'] |
| objcGroupUUID | string | ビジネスグループ UUID 空を許可しない: False 例: haha 空文字列を許可する: True 最大長: 64 |
|
| fields | array | カスタム属性フィールド（報告されるデータにこれらのフィールドが必ず含まれている必要があります。含まれていない場合、データは破棄されます） 空を許可しない: False 例: [{'name': 'ak', 'alias': '机枪'}] |
|
| templateInfo | json | テンプレート設定の詳細 空を許可しない: False 例: {} |
パラメータ補足説明¶
fieldsパラメータの説明
このパラメータは、バインドされたフィールド情報をリスト形式で格納します。リストメンバーのパラメータは以下のとおりです。
| パラメータ名 | タイプ | 説明 |
|---|---|---|
| name | string | フィールド名 |
| alias | string | フィールドエイリアス |
templateInfoパラメータの説明
詳細な構造の説明については、【リソースエクスプローラーを作成 - JSON 設定 - テンプレート設定の説明】を参照してください。
1. source パラメータの説明 リソースの所属カテゴリと、そのカテゴリを UI ページに表示する際のテキスト内容を定義します。リストメンバーのパラメータは以下のとおりです。
| パラメータ名 | タイプ | 説明 |
|---|---|---|
| key | string | リソースクラス |
| name | string | リソースクラスエイリアス |
2. filters パラメータの説明 リソースエクスプローラーのクイックフィルターにデフォルトで表示するフィールドを定義します。形式は以下のとおりです。
3. columns パラメータの説明 リソースエクスプローラーのリストにデフォルトで表示するフィールドを定義します。形式は以下のとおりです。
4. views パラメータの説明
| パラメータ | 必須 | 説明 | 記述例 |
|---|---|---|---|
| title | / | タブの表示タイトル | "テキスト" |
| required | false | タブページを表示しないかどうか。固定値：true、false。
|
"false" |
| keys | / | required パラメータと連動。キーフィールドとフィールド値のマッチングロジックを設定でき、マッチした場合に表示します。注意：このパラメータを使用する場合、required パラメータの値は true である必要があります。 |
|
| timerange | default | インターフェースデータのクエリ時間範囲の定義。基本形式：
|
|
| viewType | / | ページタイプ。現在は「組み込みページ」と「組み込みビュー」の2種類をサポートしており、それぞれ "component" と "dashboard" に対応します。 | / |
| viewName | / | ページ名。ページタイプが組み込みページの場合は、ページの相対パスを入力します。ページタイプが組み込みビューの場合は、ビュー名を入力します。下記の【組み込みページの関連付け】【組み込みビューの関連付け】の説明を参照してください。 | / |
5. templateInfo パラメータの例
{
"main": [
{
"class":"custom_object",
"source": {
"key":"リソースクラス",
"name":"リソースクラスエイリアス"
},
"filters":[
{
"key":"フィールド名"
},
{
"key":"フィールド名"
}
],
"table":{
"columns":[
{
"key":"フィールド名",
},
{
"key":"フィールド名",
}
],
},
"detail":{
"views":[
{
"title":"タブタイトル",
"required":"false",
"keys":{},
"view_type": "component",
"viewName":"組み込みページ"
},
{
"title":"タブタイトル",
"required":"false",
"keys":{},
"timerange":"default",
"view_type": "dashboard",
"viewName":"組み込みビュー"
}
]
}
}
],
"title": "リソースクラスまたはエイリアス"
}
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/objc_cfg/test/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"sourceType":"custom_object","objcGroupUUID":"objcg_xxxx","fields":[{"name":"name"}],"templateInfo":{"iconSet":{},"main":[{"class":"custom_object","source":{"key":"test","name":""},"filters":[],"fills":[],"groups":[],"table":{"columns":[],"detail":{"views":[{"keys":{},"viewType":"dashboard","viewName":"NtpQ Monitor View","title":"viewer","required":true,"timerange":"default"}]}}}],"title":"test"}}' \
--compressed
レスポンス¶
{
"code": 200,
"content": {
"conditions": "{ source = 'kodo-log' and ( hostname in [ '127.0.0.1' ] )}",
"createAt": 1677653414,
"creator": "acnt_xxxx32",
"deleteAt": -1,
"desc": "",
"filters": [
{
"condition": "and",
"name": "hostname",
"operation": "in",
"value": [
"127.0.0.1"
]
}
],
"id": 24,
"name": "Rule1",
"source": "kodo-log",
"status": 0,
"type": "logging",
"updateAt": 1678029845.282458,
"updator": "xxxx",
"uuid": "blist_xxxx32",
"workspaceUUID": "wksp_xxxx32"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-BC365EB4-B4BA-4194-B0BB-B1AC8FA29804"
}