모든 구독 나열
GET /accounts/{account_id}/core/v1/subscriptions
컬렉션에서 일치하는 모든 리소스를 JSON 배열로 반환합니다. 요청에 개별 필드가 지정된 경우, items JSON 배열에는 지정된 순서대로 각 일치하는 리소스에 대해 요청된 필드가 포함됩니다.
매개변수
| 이름 | 유형 | 에서 | 필수 요소입니다 | 설명 |
|---|---|---|---|---|
account_id |
문자열 |
경로 |
참 |
포함하는 계정 리소스의 ID
|
계속 |
쿼리 |
거짓 |
목록 표시를 재개할 토큰을 나타냅니다. URL 예시: "continue= OpenAPI 예시: " |
|
카운트 |
문자열 |
쿼리 |
거짓 |
메타데이터 개체에서 총 리소스 수를 반환해야 하는지 여부를 나타냅니다. URL 예: "count=true" OpenAPI 예: "true" |
필터 |
문자열 |
쿼리 |
거짓 |
컬렉션 목록을 표시할 때 리소스를 반환하기 위해 어떤 필드를 일치시켜야 하는지를 나타냅니다. 지원되는 연산자는 다음과 같습니다.
URL 예: "filter=field%20eq%20%27value%27" OpenAPI 예: "field eq 'value'" |
포함 |
문자열 |
쿼리 |
거짓 |
컬렉션 목록을 표시할 때 어떤 필드를 반환해야 하는지 지정합니다. URL 예: "include=id", "include=id,name" OpenAPI 예: "id" |
제한 |
문자열 |
쿼리 |
거짓 |
컬렉션 목록을 표시할 때 반환할 최대 리소스 수를 나타냅니다. URL 예: "limit=2" OpenAPI 예: "2" |
주문 |
문자열 |
쿼리 |
거짓 |
컬렉션을 나열할 때 리소스의 정렬 순서를 나타냅니다. URL 예시: "orderBy=name", "orderBy=name%20desc" OpenAPI 예: "name desc" |
건너뛰기 |
문자열 |
쿼리 |
거짓 |
컬렉션 목록을 작성할 때 건너뛸 리소스의 수를 나타냅니다. URL 예: "skip=1" OpenAPI 예제: "1" |
응답
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[다음 중 하나: "subscription_1.2_get_response_body", array[]] |
참 |
|
메타데이터 |
참 |
응답 예
{
"type": "application/astra-subscriptions",
"version": "1.2",
"items": [
{
"type": "application/astra-subscription",
"version": "1.1",
"id": "d4c865c9-64a7-4661-ae4a-3307dffcd3da",
"customerProfileID": "2157047189",
"paymentProfileID": "E7CEB0A9F1BECA32A02493E1B31D5955",
"paymentExpiry": "2022-02-01T00:00:00Z",
"purchaseOrderNumber": "72384632",
"marketplace": "netapp",
"licenseSN": "278343",
"terms": "trial",
"status": "inactive",
"appLimit": 0,
"namespaceLimit": 10,
"subscriptionPeriod": 90,
"gracePeriod": 7,
"reminderBeforePeriod": 30,
"onboardStatus": "success",
"costPerAppUnit": 0,
"costPerNamespaceUnit": 0.005,
"metadata": {
"labels": [],
"creationTimestamp": "2020-05-06T12:24:52.256624Z",
"modificationTimestamp": "2020-05-06T12:24:52.256624Z",
"createdBy": "11c0cfa1-4f27-4ef7-a21c-cb452fc5c9aa"
}
},
{
"type": "application/astra-subscription",
"version": "1.1",
"id": "4c43ed8b-078f-4fe3-b8c6-5d515f6382e6",
"customerProfileID": "2157047189",
"paymentProfileID": "E7CEB0A9F1BECA32A02493E1B31D5955",
"paymentExpiry": "2022-05-01T00:00:00Z",
"purchaseOrderNumber": "92374658",
"marketplace": "netapp",
"licenseSN": "374623",
"terms": "paid",
"status": "active",
"appLimit": 0,
"namespaceLimit": -1,
"subscriptionPeriod": -1,
"gracePeriod": -1,
"reminderBeforePeriod": -1,
"onboardStatus": "success",
"costPerAppUnit": 0,
"costPerNamespaceUnit": 0.005,
"metadata": {
"labels": [],
"creationTimestamp": "2020-08-06T12:24:52.256624Z",
"modificationTimestamp": "2020-08-06T12:24:52.256624Z",
"createdBy": "11c0cfa1-4f27-4ef7-a21c-cb452fc5c9aa"
}
}
],
"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_label
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
이름 |
문자열 |
참 |
|
값 |
문자열 |
참 |
type_astra_메타데이터_업데이트
리소스와 연결된 클라이언트 및 서비스 지정 메타데이터입니다. 정의된 값은 다음과 같습니다.
-
Astra 메타데이터 스키마를 준수합니다. 생성 시 지정하지 않으면 레이블 없이 메타데이터 객체가 생성됩니다. 업데이트 시 지정하지 않으면 메타데이터 객체의 레이블인 creationTimestamp와 createdBy는 수정 없이 유지됩니다.
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
라벨 |
거짓 |
||
CreationTimestamp 를 클릭합니다 |
문자열 |
거짓 |
|
modificationTimestamp |
문자열 |
거짓 |
|
생성 시 |
문자열 |
거짓 |
|
modifiedBy |
문자열 |
거짓 |
subscription_1.2_get_response_body
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
유형 |
문자열 |
참 |
리소스의 미디어 유형입니다. 정의된 값은 다음과 같습니다.
|
버전 |
문자열 |
참 |
리소스 버전입니다. 정의된 값은 다음과 같습니다.
|
ID입니다 |
문자열 |
참 |
리소스의 전역 고유 식별자입니다. 정의된 값은 다음과 같습니다.
|
고객 프로필 ID |
문자열 |
참 |
http://authorize.net["Authorize.net"]에서 UI에 의해 호출된 고객 프로필 ID가 포함된 JSON 문자열이 체험 기간에 대해 설정되지 않았습니다. 설정되지 않은 경우 읽기 작업 중에 빈 문자열을 반환합니다. 정의된 값은 다음과 같습니다.
|
paymentProfileID |
문자열 |
거짓 |
UI에서 호출된 "Authorize.net"의 결제 프로필 ID를 포함하는 JSON 문자열입니다. 체험 기간에는 설정되지 않습니다. 설정되지 않은 경우 읽기 작업 중에 빈 문자열을 반환합니다. 정의된 값은 다음과 같습니다.
|
paymentExpiry |
문자열 |
거짓 |
결제 수단 만료 시점을 나타내는 타임스탬프가 포함된 JSON 문자열입니다. 이 값은 authorize.net에서 가져오며(http://authorize.net UI에서 설정됩니다. 정의된 값은 다음과 같습니다.
|
purchaseOrderNumber |
문자열 |
거짓 |
결제 방식에 대한 구매 주문 번호가 포함된 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
마켓플레이스 |
문자열 |
거짓 |
결제 내역이 기록될 계정의 마켓플레이스를 나타내는 JSON 문자열입니다. 정의된 값:
|
licenseSN |
문자열 |
거짓 |
결제 수단에 대한 라이선스 일련 번호가 포함된 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
약관 |
문자열 |
참 |
계정의 현재 등급을 나타내는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
상태 |
문자열 |
참 |
구독의 현재 상태를 나타내는 JSON 문자열입니다. 정의된 값은 다음과 같습니다.
|
appLimit |
숫자 |
참 |
이 구독에 대한 애플리케이션 제한을 나타내는 JSON 숫자입니다. 값이 -1이면 제한이 없음을 의미합니다. |
namespaceLimit |
숫자 |
참 |
이 구독에 대한 네임스페이스 제한을 나타내는 JSON 숫자입니다. 값이 -1이면 제한이 없음을 의미합니다. |
subscriptionPeriod |
숫자 |
참 |
구독 기간을 나타내는 JSON 숫자입니다. -1 값은 제한이 없음을 의미합니다. 단위: 일 |
gracePeriod |
숫자 |
참 |
체험 구독이 만료되거나 유료 구독이 취소된 후 유예 기간을 나타내는 JSON 숫자입니다. 단위: 일 |
reminderBeforePeriod |
숫자 |
참 |
JSON 형식의 숫자로, 체험 구독 종료 전 고객 알림이 시작되는 시점까지의 일수를 나타냅니다. 값은 일 단위로 표시되며, -1은 해당되지 않음을 의미합니다. |
onboardStatus |
문자열 |
참 |
고객 온보딩의 현재 상태를 나타내는 JSON 문자열입니다. 유효한 값은 "not started", "in progress", "success", "failed"입니다. 정의된 값은 다음과 같습니다.
|
costPerAppUnit |
숫자 |
참 |
앱 단위당 비용을 나타내는 JSON 형식의 숫자입니다. 체험판의 경우 값은 0입니다. 단위: 미국 달러 |
costPerNamespaceUnit |
숫자 |
참 |
네임스페이스 단위당 비용을 나타내는 JSON 숫자입니다. 평가판의 경우 값은 0입니다. 단위: 미국 달러 |
메타데이터 |
참 |
리소스와 연결된 클라이언트 및 서비스 지정 메타데이터입니다. 정의된 값은 다음과 같습니다.
|
type_astra_메타데이터_목록
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
계속 |
문자열 |
거짓 |
|
카운트 |
숫자 |
거짓 |
|
라벨 |
거짓 |
||
CreationTimestamp 를 클릭합니다 |
문자열 |
거짓 |
|
modificationTimestamp |
문자열 |
거짓 |
|
생성 시 |
문자열 |
거짓 |
|
modifiedBy |
문자열 |
거짓 |
invalidParams
| 이름 | 유형 | 필수 요소입니다 | 설명 |
|---|---|---|---|
이름 |
문자열 |
참 |
잘못된 쿼리 매개변수의 이름 |
이유 |
문자열 |
참 |
쿼리 매개변수가 유효하지 않은 이유 |