콘텐츠로 이동

수정



POST /api/v1/dashboard/{dashboard_uuid}/modify

개요

내장 뷰의 이름, 설명, 식별자 또는 바인딩 조건을 업데이트합니다.

호출 전 및 사용 단계

먼저 내장 뷰 상세를 호출하여 기존 dashboardBidding과 이름을 저장합니다. dashboardBidding을 생략하거나 빈 객체를 제출하면 기존 바인딩이 모두 삭제됩니다. 이름 등 필드만 변경하고 바인딩을 유지해야 하는 경우에도 상세 조회에서 반환된 전체 dashboardBidding을 제출해야 합니다. 수정 후에는 상세 조회로 다시 확인합니다.

라우트 파라미터

파라미터명 유형 필수 설명
dashboard_uuid string Y 현재 워크스페이스의 내장 뷰 UUID.
예: dsbd_inner_example
획득 또는 입력 방법: 내장 뷰 목록의 content.data[].uuid에서 가져오거나, 생성 응답의 content.uuid를 사용할 수도 있습니다.

요청 헤더

파라미터명 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명.
예: <DF-API-KEY>
획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

Body 요청 파라미터

파라미터명 유형 필수 설명
dashboardBidding.* array 속성 값은 해당 필드의 매칭 조건 배열입니다.
예: [{"op": "in", "value": ["web-01"]}]
획득 또는 입력 방법: 내장 뷰 상세로 현재 바인딩을 읽거나, 뷰로 이동해야 하는 로그, 객체 등의 데이터에서 필드 값을 확인합니다.
dashboardBidding.*[].op string in은 주어진 값 중 하나와 매칭하고, wildcard는 와일드카드 패턴으로 매칭합니다. 소스 필드 값이 비어 있지 않으면 단독 * 는 모든 값을 매칭할 수 있습니다. 여러 조건은 임의 매칭으로 처리됩니다.
예: in
획득 또는 입력 방법: 상세 조회에서 해당 필드의 매칭 방식을 우선 그대로 사용합니다.
dashboardBidding.*[].value array 문자열 배열입니다. 워크스페이스에서 왼쪽 와일드카드를 제한하는 경우 *example 형식을 사용하지 마세요.
예: ["web-01"]
획득 또는 입력 방법: 원본 데이터의 해당 필드에서 실제 값을 선택합니다. 태그를 매칭해야 하는 경우 label을, 원본 데이터를 매칭해야 하는 경우 df_label을 사용할 수 있습니다.
name string 내장 뷰 이름, 최대 256자.
null 허용: False
최대 길이: 256
예: 主机详情内置视图
획득 또는 입력 방법: 현재 워크스페이스에서 다른 내장 뷰가 사용하지 않는 이름을 입력합니다.
desc string 내장 뷰 설명, 최대 2048자.
null 허용: False
최대 길이: 2048
예: 根据主机查看运行状态
획득 또는 입력 방법: 해당 뷰의 용도를 입력합니다.
identifier string 동일 워크스페이스 내 내장 뷰 식별자는 고유해야 하며 최대 128자이고 비워 둘 수 있습니다.
null 허용: False
빈 문자열 허용: True
최대 길이: 128
예: host-overview
획득 또는 입력 방법: 안정적인 식별자를 직접 정의하며, 수정 전에 상세 조회로 현재 identifier를 가져올 수 있습니다.
dashboardBidding json 전체 바인딩 조건으로, 비어 있지 않은 객체를 제출하면 전체가 교체되며, 생략하거나 {}를 전달하면 바인딩이 삭제됩니다.
null 허용: False
예: {"host": [{"op": "in", "value": ["web-01"]}]}
획득 또는 입력 방법: 내장 뷰 상세로 현재 바인딩을 읽거나, 뷰로 이동해야 하는 로그, 객체 등의 데이터에서 필드 값을 확인합니다.

파라미터 추가 설명

식별자를 변경할 때는 해당 식별자에 의존하는 호출도 함께 동기화해야 합니다. 바인딩을 유지하려면 예시 값 대신 자신의 상세 조회 결과로 대체하세요.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/dashboard/dsbd_inner_example/modify' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"name":"主机详情内置视图 v2","dashboardBidding":{"host":[{"op":"in","value":["web-01"]}]}}'

응답

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 내장 뷰 리소스 소유 유형이며, 내장 뷰는 inner입니다.
content.type string 내장 뷰 유형, 예: CUSTOM.
content.isPublic integer 상세 조회 접근 범위. 1은 공개, 0은 생성한 신원만 접근 가능.
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.extend object 내장 뷰 확장 정보.
content.mapping array<object> 변수 필드 매핑 정보.
content.dashboardBindSet array 뷰 바인딩 설정.
content.createdWay string 리소스 생성 출처.
content.openPermissionSet boolean 엔터티 레코드의 권한 설정 스위치.
content.permissionSet array<string> 레코드의 작업 권한 주체 UUID.
content.readPermissionSet array<string> 레코드의 읽기 권한 주체 UUID.
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.creatorInfo.uuid string 해당 신원이 조회된 경우 제공될 수 있습니다. 신원 식별자.
content.creatorInfo.status integer 해당 신원이 조회된 경우 제공될 수 있습니다. 계정 상태.
content.creatorInfo.wsAccountStatus integer 해당 신원이 조회된 경우 제공될 수 있습니다. 워크스페이스 멤버 상태.
content.creatorInfo.username string 해당 신원이 조회된 경우 제공될 수 있습니다. 로그인 이름.
content.creatorInfo.name string 해당 신원이 조회된 경우 제공될 수 있습니다. 표시 이름.
content.creatorInfo.iconUrl string 해당 신원이 조회된 경우 제공될 수 있습니다. 아바타 URL.
content.creatorInfo.email string 해당 신원이 조회된 경우 제공될 수 있습니다. 계정 이메일. API Key 신원인 경우 해당 식별자가 반환될 수 있습니다.
content.creatorInfo.mobile string 해당 신원이 조회된 경우 제공될 수 있습니다. 연락처.
content.creatorInfo.countryCode string 해당 신원이 조회된 경우 제공될 수 있습니다. 휴대폰 번호 국가 또는 지역 코드.
content.creatorInfo.acntWsNickname string 해당 신원이 조회된 경우 제공될 수 있습니다. 워크스페이스 내 닉네임.
content.updatorInfo.uuid string 해당 신원이 조회된 경우 제공될 수 있습니다. 신원 식별자.
content.updatorInfo.status integer 해당 신원이 조회된 경우 제공될 수 있습니다. 계정 상태.
content.updatorInfo.wsAccountStatus integer 해당 신원이 조회된 경우 제공될 수 있습니다. 워크스페이스 멤버 상태.
content.updatorInfo.username string 해당 신원이 조회된 경우 제공될 수 있습니다. 로그인 이름.
content.updatorInfo.name string 해당 신원이 조회된 경우 제공될 수 있습니다. 표시 이름.
content.updatorInfo.iconUrl string 해당 신원이 조회된 경우 제공될 수 있습니다. 아바타 URL.
content.updatorInfo.email string 해당 신원이 조회된 경우 제공될 수 있습니다. 계정 이메일. API Key 신원인 경우 해당 식별자가 반환될 수 있습니다.
content.updatorInfo.mobile string 해당 신원이 조회된 경우 제공될 수 있습니다. 연락처.
content.updatorInfo.countryCode string 해당 신원이 조회된 경우 제공될 수 있습니다. 휴대폰 번호 국가 또는 지역 코드.
content.updatorInfo.acntWsNickname string 해당 신원이 조회된 경우 제공될 수 있습니다. 워크스페이스 내 닉네임.
content.old_name string 업데이트 전 이름.
content.dashboardBidding object 바인딩 조건 객체. 바인딩이 없으면 빈 객체입니다.
content.dashboardBidding.* array<object> 실제 소스 필드 기준으로 구성된 매칭 조건 배열.
content.dashboardBidding.*[].op string 매칭 연산자.
content.dashboardBidding.*[].value array<string> 매칭 값 배열.
content.tagInfo array<object> 내장 뷰에서는 현재 빈 배열을 반환합니다.
content.declaration object 또는 null 워크스페이스의 공용 선언.
{
  "code": 200,
  "content": {
    "id": 72,
    "uuid": "dsbd_inner_example",
    "name": "主机详情内置视图 v2",
    "desc": "根据主机查看运行状态",
    "workspaceUUID": "wksp_example",
    "identifier": "host-overview",
    "ownerType": "inner",
    "type": "CUSTOM",
    "isPublic": 1,
    "chartPos": [],
    "chartGroupPos": [],
    "iconSet": {},
    "extend": {},
    "mapping": [],
    "dashboardBindSet": [],
    "createdWay": "manual",
    "openPermissionSet": false,
    "permissionSet": [],
    "readPermissionSet": [],
    "status": 0,
    "creator": "wsak_example",
    "updator": "wsak_example",
    "createAt": 1785427200,
    "updateAt": 1785427320,
    "deleteAt": -1,
    "old_name": "主机详情内置视图",
    "dashboardBidding": {
      "host": [
        {
          "op": "in",
          "value": [
            "web-01"
          ]
        }
      ]
    },
    "tagInfo": [],
    "creatorInfo": {},
    "updatorInfo": {},
    "declaration": {}
  },
  "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.ForbiddenOperationResource API Key에 대상 뷰에 대한 유효한 작업 권한이 없음 작업 권한 없음 워크스페이스 소속과 API Key 권한을 확인하거나 리소스 생성자에게 문의합니다.
406 ft.ParameterCheckFailed 워크스페이스가 왼쪽 와일드카드를 제한하는데 바인딩 값이 *로 시작하는 와일드카드 조건에 매칭됨 쿼리 설정에서 퍼지 매칭의 왼쪽 * 매칭은 아직 지원되지 않습니다 값 앞의 *를 제거하거나 정확한 값으로 변경합니다. 이 제한은 wildcard 또는 필드명이 * , -* 로 시작하는 조건에 적용되며, 단독 * 는 이 검증을 트리거하지 않습니다. 오류 응답의 content는 true입니다.
400 ft.IdentificationIdExists 식별자가 동일 워크스페이스의 다른 내장 뷰에서 이미 사용 중임 식별자 ID가 이미 존재함 사용되지 않은 식별자를 선택하거나 해당 필드를 생략하여 원래 값을 유지합니다.
400 ft.ObjectParmeterExists 새 이름이 현재 워크스페이스의 다른 내장 뷰에서 이미 사용 중임 {} 이(가) 이미 존재합니다 아직 사용되지 않은 이름으로 변경합니다.

문서 평가

이 페이지가 도움이 되었나요?