수정¶
POST /api/v1/objc_cfg/{objc_name}/modify
개요¶
리소스 카탈로그 구성 수정
경로 매개변수¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| objc_name | string | Y | 리소스 카탈로그 구성 이름 |
본문 요청 매개변수¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| 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 | / | Tab 표시 제목 | "텍스트" |
| required | false | Tab 페이지를 표시하지 않을지 여부, 고정값: true, false。
|
"false" |
| keys | / | required 매개변수와 연동되며, 키 필드와 필드 값 일치 로직을 구성할 수 있습니다. 일치하는 경우 표시됩니다. 참고: 이 매개변수가 적용되는 경우 required 매개변수 값은 반드시 true여야 합니다. |
|
| timerange | default | 인터페이스 데이터 조회 시간 범위 정의。기본 형식：
|
|
| viewType | / | 페이지 유형。현재 "내장 페이지"와 "내장 뷰" 두 가지 유형을 지원하며, 각각 "component"와 "dashboard"에 해당합니다。 | / |
| viewName | / | 페이지 이름。페이지 유형이 내장 페이지인 경우 페이지의 상대 경로 주소를 입력해야 합니다. 페이지 유형이 내장 뷰인 경우 뷰 이름을 입력하면 됩니다. 아래의 [내장 페이지 연결][내장 뷰 연결] 설명을 참조하세요. | / |
5. templateInfo 매개변수 예시
{
"main": [
{
"class":"custom_object",
"source": {
"key":"리소스 클래스",
"name":"리소스 클래스 별칭"
},
"filters":[
{
"key":"필드 이름"
},
{
"key":"필드 이름"
}
],
"table":{
"columns":[
{
"key":"필드 이름",
},
{
"key":"필드 이름",
}
],
},
"detail":{
"views":[
{
"title":"Tab 제목",
"required":"false",
"keys":{},
"view_type": "component",
"viewName":"내장 페이지"
},
{
"title":"Tab 제목",
"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"
}