모든 볼륨 나열
GET /accounts/{account_id}/topology/v1/volumes
컬렉션에서 일치하는 모든 리소스를 JSON 배열로 반환합니다. 요청에 개별 필드가 지정된 경우, items JSON 배열에는 지정된 순서대로 각 일치하는 리소스에 대해 요청된 필드가 포함됩니다.
매개변수
| 이름 | 유형 | 에서 | 필수 요소입니다 | 설명 |
|---|---|---|---|---|
account_id |
문자열 |
경로 |
참 |
포함하는 계정 리소스의 ID
|
포함 |
문자열 |
쿼리 |
거짓 |
컬렉션 목록을 표시할 때 어떤 필드를 반환해야 하는지 지정합니다. URL 예: "include=id", "include=id,name" OpenAPI 예: "id"
|
제한 |
문자열 |
쿼리 |
거짓 |
컬렉션 목록을 표시할 때 반환할 최대 리소스 수를 나타냅니다. URL 예: "limit=2" OpenAPI 예제: "2" |
응답
Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
항목 |
array[다음 중 하나: "volume_1.2_get_response_body", array[]] |
참 |
|
메타데이터 |
참 |
응답 예
{
"type": "application/astra-volumes",
"version": "1.2",
"items": [
[
"24fe6e79-bf8d-45c9-96af-ef1d11fbd4a0",
"myVolume"
],
[
"20a370f4-957f-446a-9126-08853d01933a",
"secondVol"
],
[
"48e349a2-5bcd-4c59-896c-12b8240e634b",
"smallVol"
]
],
"metadata": {
"labels": [],
"creationTimestamp": "2022-10-06T20:58:16.305662Z",
"modificationTimestamp": "2022-10-06T20:58:16.305662Z",
"createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
}
}
응답
Status: 401, Unauthorized
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
유형 |
문자열 |
참 |
|
제목 |
문자열 |
참 |
|
세부 정보 |
문자열 |
참 |
|
상태 |
문자열 |
참 |
|
correlationID |
문자열 |
거짓 |
응답 예
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
응답
Status: 400, Bad request
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
유형 |
문자열 |
참 |
|
제목 |
문자열 |
참 |
|
세부 정보 |
문자열 |
참 |
|
상태 |
문자열 |
참 |
|
correlationID |
문자열 |
거짓 |
|
invalidParams |
배열["invalidParams"] |
거짓 |
유효하지 않은 쿼리 매개변수 목록 |
응답 예
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
응답
Status: 403, Forbidden
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
유형 |
문자열 |
참 |
|
제목 |
문자열 |
참 |
|
세부 정보 |
문자열 |
참 |
|
상태 |
문자열 |
참 |
|
correlationID |
문자열 |
거짓 |
응답 예
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
오류
Status: 404, Not found
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
유형 |
문자열 |
참 |
|
제목 |
문자열 |
참 |
|
세부 정보 |
문자열 |
참 |
|
상태 |
문자열 |
참 |
|
correlationID |
문자열 |
거짓 |
예시 오류 응답
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
정의
정의를 참조하세요
type_astra_stateDetail
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
유형 |
문자열 |
참 |
|
제목 |
문자열 |
참 |
|
세부 정보 |
문자열 |
참 |
type_astra_label
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
이름 |
문자열 |
참 |
|
값 |
문자열 |
참 |
type_astra_메타데이터
리소스와 연결된 클라이언트 및 서비스 지정 메타데이터입니다. 정의된 값은 다음과 같습니다.
-
Astra 메타데이터 스키마를 준수합니다.
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
라벨 |
참 |
||
CreationTimestamp 를 클릭합니다 |
문자열 |
참 |
|
modificationTimestamp |
문자열 |
참 |
|
생성 시 |
문자열 |
참 |
|
modifiedBy |
문자열 |
거짓 |
volume_1.2_get_response_body
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
유형 |
문자열 |
참 |
리소스의 미디어 유형입니다. 정의된 값은 다음과 같습니다.
|
버전 |
문자열 |
참 |
리소스 버전입니다. 정의된 값은 다음과 같습니다.
|
ID입니다 |
문자열 |
참 |
리소스의 전역 고유 식별자입니다. 정의된 값은 다음과 같습니다.
|
이름 |
문자열 |
참 |
볼륨 이름이 포함된 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
상태 |
문자열 |
거짓 |
볼륨의 작동 상태를 나타내는 값을 포함하는 JSON 문자열입니다. |
크기 |
문자열 |
거짓 |
볼륨의 크기를 포함하는 JSON 문자열입니다. |
사용된 |
숫자 |
거짓 |
프로비저닝된 볼륨에서 사용된 할당량의 바이트 수를 포함하는 JSON 번호입니다. |
usedPercentage |
숫자 |
거짓 |
사용된 볼륨의 백분율을 포함하는 JSON 숫자입니다. |
총 |
숫자 |
거짓 |
프로비저닝된 볼륨의 총 바이트 수를 포함하는 JSON 숫자입니다. |
creationToken |
문자열 |
거짓 |
볼륨의 생성 토큰이 포함된 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
snapshotPossible |
문자열 |
거짓 |
드라이버가 볼륨의 스냅샷을 수행할 수 있는지 여부를 나타내는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
storageClass |
문자열 |
거짓 |
볼륨의 스토리지 클래스를 포함하는 JSON 문자열입니다.
|
pvcName |
문자열 |
거짓 |
볼륨의 PersistentVolumeClaim(PVC) 이름을 포함하는 JSON 문자열입니다.
|
internalName |
문자열 |
거짓 |
대상 스토리지 클러스터의 볼륨 내부 이름을 포함하는 JSON 문자열입니다(사용 가능한 경우). 이 이름은 Kubernetes CSI 드라이버에서 가져옵니다.
|
appsUsing |
배열[string] |
참 |
볼륨을 사용 중인 애플리케이션의 ID를 각각 포함하는 JSON 문자열의 JSON 배열입니다. 정의된 값은 다음과 같습니다.
|
storageBackendID |
문자열 |
거짓 |
볼륨을 제공하는 스토리지 백엔드의 ID가 포함된 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
오케스트레이터 |
문자열 |
거짓 |
이 볼륨의 오케스트레이터를 포함하는 JSON 문자열입니다. 이 값은 Astra Data Store 볼륨에 대해 정의됩니다. 정의된 값은 다음과 같습니다.
|
serviceLevel |
문자열 |
거짓 |
스토리지 백엔드 수준에서 이 볼륨에 대해 정의된 서비스 품질(QoS) 정책을 포함하는 JSON 문자열입니다. 이 값은 Astra Data Store 볼륨에 대해 정의됩니다. |
exportPolicy |
문자열 |
거짓 |
이 볼륨과 연결된 내보내기 정책이 포함된 JSON 문자열입니다. 이 값은 Astra Data Store 볼륨에 대해 정의됩니다. |
nodeId |
문자열 |
거짓 |
볼륨을 제공하는 노드 ID가 포함된 JSON 문자열입니다. 이 값은 Astra Data Store 볼륨에 대해 정의됩니다. 정의된 값은 다음과 같습니다.
|
healthState |
문자열 |
거짓 |
볼륨의 상태를 나타내는 값을 포함하는 JSON 문자열입니다. 이 값은 Astra Data Store 볼륨에 대해 정의됩니다. 정의된 값은 다음과 같습니다.
|
healthStateDetails |
참 |
현재 상태에 대한 추가 세부 정보를 나열하는 JSON 객체의 JSON 배열입니다. 정보가 없는 경우 이 배열은 비어 있습니다.
|
|
메타데이터 |
참 |
리소스와 연결된 클라이언트 및 서비스 지정 메타데이터입니다. 정의된 값은 다음과 같습니다.
|
type_astra_메타데이터_목록
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
계속 |
문자열 |
거짓 |
|
카운트 |
숫자 |
거짓 |
|
라벨 |
거짓 |
||
CreationTimestamp 를 클릭합니다 |
문자열 |
거짓 |
|
modificationTimestamp |
문자열 |
거짓 |
|
생성 시 |
문자열 |
거짓 |
|
modifiedBy |
문자열 |
거짓 |
invalidParams
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
이름 |
문자열 |
참 |
잘못된 쿼리 매개변수의 이름 |
이유 |
문자열 |
참 |
쿼리 매개변수가 유효하지 않은 이유 |