확장 정보 구성¶
POST /api/v1/dashboards/{dashboard_uuid}/set_extend
개요¶
하나의 대시보드에 대한 기본 쿼리 워크스페이스와 소속 사이트를 일괄 업데이트합니다.
호출 전 및 사용 단계¶
먼저 권한이 부여된 워크스페이스 목록에서 권한이 부여된 워크스페이스의 UUID와 regionCode를 가져옵니다. 동일한 구성에서는 같은 사이트의 워크스페이스를 선택합니다. 제출 후 대시보드 상세를 호출하여 extend를 확인할 수 있습니다. 제출된 확장 항목만 덮어쓰며, 기본 쿼리 스페이스를 수정하면서 targetRegion을 생략하면 기존 사이트 식별자가 정리됩니다. 데이터 쿼리는 여전히 실제 권한 부여에 따라 수행됩니다.
경로 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| 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 요청 매개변수¶
| 매개변수명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| defaultTargetWorkspaceUUIDs | array | Y | 기본 쿼리 워크스페이스 UUID 배열입니다. null 허용: False 예시: ["wksp_example"]가져오기 또는 입력 방법: 권한이 부여된 워크스페이스 목록의 대상 사이트 그룹에서 content[].data[].workspaceUUID를 복사합니다. 필요에 따라 기본 쿼리 스페이스를 설정하며, []를 전달하면 목록을 비울 수 있습니다. |
| targetRegion | string | 대상 워크스페이스가 속한 사이트의 regionCode입니다. null 허용: False 빈 문자열 허용: False 예시: site-example가져오기 또는 입력 방법: 권한이 부여된 워크스페이스 목록에서 해당 워크스페이스에 대응하는 regionCode를 가져옵니다. 현재 사이트를 사용하는 경우 생략할 수 있습니다. |
매개변수 추가 설명¶
이 API는 기본 쿼리 구성만 저장합니다. 동일한 대시보드를 동시에 수정하는 경우 직렬로 실행해야 합니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/dashboards/dsbd_example/set_extend' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"defaultTargetWorkspaceUUIDs":["wksp_example"]}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | boolean | 확장 구성이 성공적으로 저장되면 true입니다. |
{
"code": 200,
"content": true,
"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를 확인하세요. |