Resource Class Configuration Modification¶

POST /api/v1/objc_cfg/{objc_name}/modify

Overview¶

Modify resource class configuration

Route Parameters¶

Parameter Name	Type	Required	Description
objc_name	string	Y	Resource class configuration name

Body Request Parameters¶

Parameter Name	Type	Required	Description
sourceType	string	Y	Source type, default value is `custom_object` Allow empty: False Allowed values: ['object', 'custom_object']
objcGroupUUID	string		Business group UUID Allow empty: False Example: haha Allow empty string: True Max length: 64
fields	array		Custom attribute fields (data reported must include these fields, otherwise the data will be discarded) Allow empty: False Example: [{'name': 'ak', 'alias': 'machine gun'}]
templateInfo	json		Template configuration details Allow empty: False Example: {}

Parameter Additional Explanation¶

fields Parameter Explanation This parameter stores the bound field information in list form, with list member parameters as follows

Parameter Name	Type	Description
name	string	Field name
alias	string	Field alias

templateInfo Parameter Explanation

For detailed structure explanation, please refer to 【Create Resource Explorer-JSON Configuration-Template Configuration Explanation】

1. source Parameter Explanation Define the resource's classification and the text content to be displayed on the UI page, with list member parameters as follows

Parameter Name	Type	Description
key	string	Resource class
name	string	Resource class alias

2. filters Parameter Explanation Define the default fields displayed in the quick filter section of the resource explorer, formatted as follows:

"filters":[
  {
    "key":"field name"
  },
  {
    "key":"field name"
  }
]

3. columns Parameter Explanation Define the default fields displayed in the list section of the resource explorer, formatted as follows:

"columns":[
  {
    "key":"field name",
  },
  {
    "key":"field name",
  }
]

4. views Parameter Explanation

Parameter	Required	Description	Example
title	/	Tab display title	"Text"
required	false	Whether the Tab page is not displayed by default, fixed values: true, false. true: Not displayed by default, linked with keys configuration to determine if data matches, if matched then displayed false: Displayed by default	"false"
keys	/	Linked with the required parameter, can configure key fields and field value matching logic, if matched then displayed. Note: When this parameter is applied, the required parameter value must be true	{"key":"*"} : Data satisfies the key field {"key":"value"} : Data contains the key field and the value must be value {"key1":"value1","key2":"value2"} : Data contains key1 field with value1 and key2 field with value2 combination
timerange	default	Define the data query time range on the interface. Basic format: default: Follows the platform time widget default configuration, usually 15m (i.e., query the last 15 minutes of data) Relative time: Custom relative time range, time units include m(minutes), h(hours), d(days) Linked with data time field to configure forward and backward offset time periods ["forward offset","backward offset"]	"default" : Last 15 minutes "15m" : Last 15 minutes "1h" : Last 1 hour "1d" : Last 1 day ["15m","15m"] : Based on the current data time, forward and backward offset by 15 minutes respectively ["5m","30m"] : Based on the current data time, forward offset by 5 minutes and backward offset by 30 minutes
viewType	/	Page type. Currently supports "built-in page" and "built-in view" two types, corresponding to "component" and "dashboard" respectively.	/
viewName	/	Page name. If the page type is a built-in page, then the relative path address of the page needs to be filled in; if the page type is a built-in view, then the view name can be filled in directly. Refer to the following 【Associate Built-in Page】【Associate Built-in View】 explanations	/

5. templateInfo Parameter Example

{
  "main": [
    {
      "class":"custom_object",
      "source": {
        "key":"resource class",
        "name":"resource class alias"
      },
      "filters":[
        {
          "key":"field name"
        },
        {
          "key":"field name"
        }
      ],
      "table":{
        "columns":[
          {
            "key":"field name",
          },
          {
            "key":"field name",
          }
        ],
      },
      "detail":{
        "views":[
          {
            "title":"Tab title",
            "required":"false",
            "keys":{},
            "view_type": "component",
            "viewName":"built-in page"
          },
          {
            "title":"Tab title",
            "required":"false",
            "keys":{},
            "timerange":"default",
            "view_type": "dashboard",
            "viewName":"built-in view"
          }
        ]
      }
    }
  ],
  "title": "resource class or alias"
}

Request Example¶

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

Response¶

{
    "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"
}