수정¶
POST /api/v1/dashboards/{dashboard_uuid}/modify
개요¶
지정된 대시보드의 속성, 태그 및 공개 범위를 수정합니다.
호출 전 및 사용 단계¶
먼저 대시보드 상세를 호출하여 현재 구성을 읽은 후, 변경할 필드를 제출합니다. extend, mapping 또는 tagNames를 제공하면 해당 내용을 전체 교체합니다. 동일한 대시보드의 수정은 직렬로 실행하여 동시 읽기-수정-쓰기가 서로 덮어쓰지 않도록 해야 합니다. 기본 쿼리 공간만 조정하려면 확장 정보 구성을 사용합니다.
경로 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| dashboard_uuid | string | Y | 대상 대시보드 UUID. 예: dsbd_example가져오거나 입력하는 방법: 대시보드 목록의 content.data[].uuid에서 복사하거나 생성 결과의 content.uuid를 사용할 수 있습니다. |
요청 헤더¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>가져오거나 입력하는 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| name | string | 대시보드 표시 이름입니다. null 허용: False 예: 生产巡检가져오거나 입력하는 방법: 현재 워크스페이스에서 다른 대시보드가 사용하지 않는 이름을 사용합니다. |
|
| desc | string | 대시보드 설명입니다. null 허용: False 빈 문자열 허용: True 최대 길이: 2048 예: 生产服务巡检指标가져오거나 입력하는 방법: 이 대시보드의 용도를 작성하며, 빈 문자열을 전달하면 설명을 지웁니다. |
|
| identifier | string | 사용자 지정 식별 ID이며 최대 128자입니다. 이 값과 UUID는 각각 사용됩니다. null 허용: False 빈 문자열 허용: True 최대 길이: 128 예: prod-check가져오거나 입력하는 방법: 호출자의 명명 규칙에 따라 이 워크스페이스에서 다른 대시보드가 사용하지 않는 식별자를 선택합니다. |
|
| extend | json | 대시보드 확장 구성입니다. 필요에 따라 기존 필드를 재사용합니다. null 허용: False 예: {}가져오거나 입력하는 방법: 대시보드 상세의 content.extend에서 기존 객체를 가져옵니다. |
|
| mapping | array | 대시보드 변수의 필드 매핑 배열입니다. 매핑이 없으면 빈 배열을 전달할 수 있습니다. null 허용: False 예: []가져오거나 입력하는 방법: 기존 대시보드의 content.mapping 또는 내보낸 템플릿의 content.dashboardMapping에서 값을 가져옵니다. |
|
| tagNames | array | 전체 태그 목록을 제출합니다. []를 전달하면 모든 태그 연결을 해제할 수 있습니다. null 허용: False 예: ["team:ops"]가져오거나 입력하는 방법: 대시보드 상세의 content.tagInfo[].name에서 복사하거나 연결할 태그 이름을 입력합니다. |
|
| isPublic | int | 1은 공개, 0은 생성 주체만 볼 수 있음, -1은 사용자 지정 권한입니다. 생략하면 기존 공개 범위를 유지합니다. null 허용: False 예: 1가져오거나 입력하는 방법: 대상 공개 범위에 따라 1, 0 또는 -1을 선택합니다. |
|
| permissionSet | array | isPublic=-1일 때 사용하는 작업 권한 목록이며 역할(소유자 제외), 멤버 및 팀 UUID를 포함할 수 있습니다. null 허용: False 예: ["role_example"]가져오거나 입력하는 방법: 역할 목록, 멤버 목록 또는 팀 목록에서 UUID를 가져옵니다. |
|
| readPermissionSet | array | isPublic=-1일 때 사용하는 읽기 권한 목록이며 역할(소유자 제외), 멤버 및 팀 UUID를 포함할 수 있습니다. null 허용: False 예: ["role_example"]가져오거나 입력하는 방법: 역할 목록, 멤버 목록 또는 팀 목록에서 UUID를 가져옵니다. |
파라미터 추가 설명¶
필드를 생략하면 현재 값이 유지됩니다. 태그를 저장한 후 상세를 다시 호출하여 전체 연결 태그를 읽을 수 있습니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/dashboards/dsbd_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"生产巡检 v2"}'
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.id | integer | 대시보드 레코드 번호입니다. |
| content.uuid | string | 대시보드 UUID로 상세, 수정, 삭제 및 캐러셀에 사용됩니다. |
| content.workspaceUUID | string | 소속 워크스페이스입니다. |
| content.name | string | 대시보드 표시 이름입니다. |
| content.desc | string | 대시보드 설명입니다. |
| content.identifier | string | 외부 사용자 지정 식별자이며 비어 있을 수 있습니다. |
| content.ownerType | string | 리소스 유형 귀속이며 대시보드는 일반적으로 node입니다. |
| content.type | string | 대시보드 유형이며 예: CUSTOM입니다. |
| content.chartPos | array<object> |
차트 레이아웃 배열입니다. 각 항목의 chartUUID는 차트 식별자이고 pos는 레이아웃 객체입니다. |
| content.chartPos[].chartUUID | string | 연결된 차트 UUID입니다. |
| content.chartPos[].pos | object | 차트 크기 및 위치이며 예: x, y, w, h입니다. |
| content.chartGroupPos | array<string> |
차트 그룹 식별자의 정렬 순서입니다. |
| content.iconSet | object | 아이콘 설정입니다. |
| content.isPublic | integer | 1은 공개, 0은 생성 주체만 볼 수 있음, -1은 사용자 지정 권한입니다. |
| content.extend | object | 확장 구성입니다. |
| content.mapping | array<object> |
변수 필드 매핑입니다. |
| content.createdWay | string | 리소스 생성 출처입니다. |
| content.dashboardBindSet | array | 뷰 바인딩 구성입니다. |
| content.openPermissionSet | boolean | 현재 사용자 지정 권한이 활성화되어 있는지 여부입니다. |
| content.permissionSet | array<string> |
작업 권한 주체 UUID 목록입니다. |
| content.readPermissionSet | array<string> |
읽기 권한 주체 UUID 목록입니다. |
| content.tagInfo | array<object> |
이 응답과 관련된 태그 정보입니다. |
| content.tagInfo[].id | string | 태그 식별자이며 uuid와 같습니다. |
| content.tagInfo[].uuid | string | 태그 UUID입니다. |
| content.tagInfo[].name | string | 연결된 태그 이름입니다. |
| content.tagInfo[].description | string | 태그 설명입니다. |
| content.tagInfo[].colour | string | 태그 색상입니다. |
| content.tagInfo[].scope | array<string> |
태그의 적용 범위입니다. |
| content.tagInfo[].tagPermissionInfo | object | 태그 권한 부여가 있는 경우 함께 제공되는 작업 및 읽기 권한 정보입니다. |
| content.status | integer | 레코드 상태입니다. |
| content.creator | string | 생성자 주체 ID입니다. |
| content.updator | string | 최근 업데이트한 주체 ID이며, 없는 경우 비어 있을 수 있습니다. |
| content.createAt | number | 생성 시간, Unix 초입니다. |
| content.updateAt | number | 최근 업데이트 시간, Unix 초입니다. 없는 경우 -1일 수 있습니다. |
| content.deleteAt | number | 삭제 시간, Unix 초입니다. 삭제되지 않은 경우 -1입니다. |
| content.creatorInfo | object | 생성자 정보이며 빈 객체일 수 있습니다. |
| content.updatorInfo | object | 최근 업데이트한 주체 정보이며 빈 객체일 수 있습니다. |
| content.declaration | object 또는 null | 워크스페이스의 공용 선언입니다. |
| content.old_name | string | 업데이트 전 이름입니다. |
| content.dashboardBidding | object | 뷰 바인딩 데이터이며 대시보드에 관련 바인딩 정보가 없으면 빈 객체입니다. |
{
"code": 200,
"content": {
"id": 21,
"uuid": "dsbd_example",
"name": "生产巡检 v2",
"desc": "生产服务巡检指标",
"workspaceUUID": "wksp_example",
"identifier": "prod-check",
"ownerType": "node",
"type": "CUSTOM",
"chartPos": [],
"chartGroupPos": [],
"iconSet": {},
"isPublic": 1,
"extend": {},
"mapping": [],
"createdWay": "manual",
"dashboardBindSet": [],
"openPermissionSet": false,
"permissionSet": [],
"readPermissionSet": [],
"tagInfo": [],
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427320,
"deleteAt": -1,
"status": 0,
"declaration": {},
"creatorInfo": {},
"updatorInfo": {},
"old_name": "生产巡检",
"dashboardBidding": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조합니다.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 유효성 검사 조건을 위반함 | 파라미터 파싱 실패 | 파라미터 위치, 필드명, 유형 및 값을 확인합니다. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않음 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정합니다. |
| 400 | ft.JsonFormatError | JSON 구문은 유효하지만 요청 최상위가 객체가 아님 | 일부 json 파일 형식 오류 | 파라미터를 JSON 객체에 넣습니다. |
| 404 | ft.NotFoundView | 대상 대시보드가 존재하지 않거나 삭제되었거나 현재 워크스페이스에 없음 | 지정된 뷰를 찾을 수 없음 | 현재 워크스페이스의 대시보드 목록에서 반환된 UUID로 변경합니다. |
| 403 | ft.ForbiddenDashboardOperation | 호출 주체가 대상 대시보드를 조작할 수 없음 | 대시보드【{}】 작업 권한이 없습니다 | 대시보드의 공개 범위, 작업 권한 부여 및 사용 중인 API Key를 확인합니다. |
| 400 | ft.TagScopeMismatch | 태그 이름이 이미 존재하지만 해당 범위가 시나리오 태그와 호환되지 않음 | 메시지에 태그 이름과 범위가 포함됩니다. 예: team:ops: ['monitor'] -> scene. | 시나리오 또는 공용 범위의 태그 이름을 선택하거나 이름을 변경할 수 있습니다. |
| 406 | ft.ExceedMaxCharacterLimit | 태그 이름이 128자를 초과함 | {}이(가) 최대 문자 길이 제한을 초과했습니다 | 해당 태그 이름을 줄인 후 다시 제출합니다. |
| 400 | ft.ObjectParmeterExists | 수정된 이름이 다른 동일 유형 대시보드와 중복됨 | {}이(가) 이미 존재합니다 |
다른 이름을 사용하거나 대상 UUID를 확인합니다. |
| 400 | ft.IdentificationIdExists | 새 identifier가 현재 워크스페이스의 다른 대시보드에서 이미 사용 중임 | 식별 ID가 이미 존재합니다 | identifier를 변경한 후 다시 제출합니다. |
| 400 | ft.IndexDashboardForbiddenSetVisibleSet | 대상이 현재 홈페이지 대시보드이며 공개 범위가 아닌 범위가 제출됨 | 홈페이지 대시보드, 공개 범위 설정 금지 | 공개 상태를 유지합니다. 범위를 제한해야 하는 경우 먼저 워크스페이스의 홈페이지 설정을 조정합니다. |