폴더 API

폴더 API를 사용하여 Amazon 관리형 Grafana 워크스페이스에서 폴더 작업을 수행할 수 있습니다.

폴더의 식별자 (id) 는 자동으로 증가하는 숫자 값이며 작업 공간별로 고유합니다. 폴더의 고유 식별자 (uid) 는 여러 작업 영역 간에 있는 폴더를 고유하게 식별하는 데 사용할 수 있습니다. 폴더를 만들 때 입력하지 않으면 자동으로 생성됩니다. uid를 사용하면 폴더에 액세스하고 여러 Amazon Managed Grafana 작업 영역 간에 폴더를 동기화할 때 일관된 URL을 사용할 수 있습니다. uid를 사용하면 폴더 제목을 변경해도 해당 폴더로 연결되는 북마크된 링크가 깨지지 않습니다.

uid의 최대 길이는 40자일 수 있습니다.

폴더는 중첩될 수 없습니다.

참고

아마존 관리형 그라파나 워크스페이스에서 Grafana API를 사용하려면 유효한 Grafana API 토큰이 있어야 합니다. API 요청의 필드에 이를 포함시키세요. Authorization API 호출을 인증하기 위한 토큰을 생성하는 방법에 대한 자세한 내용은 을 참조하십시오토큰으로 인증.

0인 id일반 폴더는 폴더 API에 속하지 않습니다. 폴더 API를 사용하여 일반 폴더에 대한 정보를 검색할 수 없습니다.

폴더 생성

POST /api/folders

새 폴더를 만듭니다.

요청 예제

POST /api/folders HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "uid": "nErXDvCkzz",
  "title": "Department ABC"
}

JSON 본문 스키마:

• uid — 선택적 고유 식별자. null인 경우 새 uid가 생성됩니다.

• 제목 — 폴더의 제목입니다.

응답의 예

HTTP/1.1 200
Content-Type: application/json

{
  "id":1,
  "uid": "nErXDvCkzz",
  "title": "Department ABC",
  "url": "/dashboards/f/nErXDvCkzz/department-abc",
  "hasAcl": false,
  "canSave": true,
  "canEdit": true,
  "canAdmin": true,
  "createdBy": "admin",
  "created": "2018-01-31T17:43:12+01:00",
  "updatedBy": "admin",
  "updated": "2018-01-31T17:43:12+01:00",
  "version": 1
}

상태 코드:

• 200 — 생성됨

• 400 — 잘못된 JSON, 유효하지 않거나 누락된 필드 등의 오류

• 401 — 승인되지 않음

• 403 — 액세스가 거부되었습니다.

업데이트 폴더

PUT /api/folders/:uid

uid와 일치하는 기존 폴더를 업데이트합니다.

요청 예제

PUT /api/folders/nErXDvCkzz HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

{
  "title":"Department DEF",
  "version": 1
}

JSON 본문 스키마:

• uid — 고유 식별자를 변경합니다 (제공된 경우).

• 제목 — 폴더의 제목입니다.

• 버전 - 폴더를 덮어쓸 수 있는 현재 버전을 제공합니다. 경우에는 overwrite=true 필요하지 않습니다.

• 덮어쓰기 - 기존 폴더를 새 버전으로 true 덮어쓰려면 로 설정합니다.

응답의 예

HTTP/1.1 200
Content-Type: application/json

{
  "id":1,
  "uid": "nErXDvCkzz",
  "title": "Department DEF",
  "url": "/dashboards/f/nErXDvCkzz/department-def",
  "hasAcl": false,
  "canSave": true,
  "canEdit": true,
  "canAdmin": true,
  "createdBy": "admin",
  "created": "2018-01-31T17:43:12+01:00",
  "updatedBy": "admin",
  "updated": "2018-01-31T17:43:12+01:00",
  "version": 1
}

상태 코드:

• 200 — 생성됨

• 400 — 잘못된 JSON, 유효하지 않거나 누락된 필드 등의 오류

• 401 — 승인되지 않음

• 403 — 액세스가 거부되었습니다.

• 404 — 폴더를 찾을 수 없음

• 412 — 사전 조건 실패

412 상태 코드는 폴더를 업데이트할 수 없는 이유를 설명하는 데 사용됩니다.

• 다른 사람이 폴더를 변경했습니다. status=version-mismatch

응답 본문에는 다음과 같은 속성이 있습니다.

HTTP/1.1 412 Precondition Failed
Content-Type: application/json; charset=UTF-8
Content-Length: 97

{
  "message": "The folder has been changed by someone else",
  "status": "version-mismatch"
}

모든 폴더 가져오기

GET /api/folders

보기 권한이 있는 모든 폴더를 반환합니다. limit쿼리 매개 변수를 사용하여 반환되는 최대 폴더 수를 제어할 수 있습니다. 기본값은 1000입니다.

요청 예제

GET /api/folders?limit=10 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

응답의 예

HTTP/1.1 200
Content-Type: application/json

[
  {
    "id":1,
    "uid": "nErXDvCkzz",
    "title": "Department ABC"
  },
  {
    "id":2,
    "uid": "k3S1cklGk",
    "title": "Department RND"
  }
]

uid별로 폴더 가져오기

GET /api/folders/:uid

주어진 uid와 일치하는 모든 폴더를 반환합니다.

요청 예제

GET /api/folders/nErXDvCkzzh HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

응답의 예

HTTP/1.1 200
Content-Type: application/json

{
  "id":1,
  "uid": "nErXDvCkzz",
  "title": "Department ABC",
  "url": "/dashboards/f/nErXDvCkzz/department-abc",
  "hasAcl": false,
  "canSave": true,
  "canEdit": true,
  "canAdmin": true,
  "createdBy": "admin",
  "created": "2018-01-31T17:43:12+01:00",
  "updatedBy": "admin",
  "updated": "2018-01-31T17:43:12+01:00",
  "version": 1
}

상태 코드:

• 200 — 찾음

• 401 — 승인되지 않았습니다

• 403 — 액세스가 거부되었습니다.

• 404 — 찾을 수 없음

ID로 폴더 가져오기

GET /api/folders/id/:id

주어진 ID와 일치하는 폴더를 반환합니다.

요청 예제

GET /api/folders/id/1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

응답의 예

HTTP/1.1 200
Content-Type: application/json

{
  "id":1,
  "uid": "nErXDvCkzz",
  "title": "Department ABC",
  "url": "/dashboards/f/nErXDvCkzz/department-abc",
  "hasAcl": false,
  "canSave": true,
  "canEdit": true,
  "canAdmin": true,
  "createdBy": "admin",
  "created": "2018-01-31T17:43:12+01:00",
  "updatedBy": "admin",
  "updated": "2018-01-31T17:43:12+01:00",
  "version": 1
}

상태 코드:

• 200 — 찾음

• 401 — 승인되지 않았습니다

• 403 — 액세스가 거부되었습니다.

• 404 — 찾을 수 없음

uid로 폴더 삭제

DELETE /api/folders/:uid

uid와 일치하는 폴더를 삭제하고 폴더에 저장된 모든 대시보드도 삭제합니다. 이 작업은 되돌릴 수 없습니다.

요청 예제

DELETE /api/folders/nErXDvCkzz HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk

응답의 예

HTTP/1.1 200
Content-Type: application/json

{
  "message":"Folder deleted",
  "id": 2
}

상태 코드:

• 200 — 삭제됨

• 401 — 승인되지 않았습니다

• 403 — 액세스가 거부되었습니다.

• 404 — 찾을 수 없음