Usage Plan이 연결된 Stage 조회
- 인쇄
- PDF
Usage Plan이 연결된 Stage 조회
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
지정한 Usage Plan이 연결된 Stage의 상세 정보를 조회합니다.요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
GET | /usage-plans/{usage-plan-id}/stages |
요청 헤더
API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
usage-plan-id | String | Required | Stage를 조회할 Usage Plan ID
|
요청 쿼리 파라미터
파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
offset | Long | Optional | 응답 데이터의 시작 지점
|
limit | Long | Optional | 응답 데이터의 최대 수
|
name | String | Optional | 조회할 Stage의 이름
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/usage-plans/***9rpm***/stages' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
응답
응답 형식을 설명합니다.
응답 구문
응답 구문은 다음과 같습니다.
{
"total" : 0,
"stages" : [ {
"apiName" : "apiName",
"stageName" : "stageName",
"productId" : "productId",
"apiId" : "apiId",
"productName" : "productName",
"stageId" : "stageId"
} ],
"usagePlan" : {
"domainCode" : "domainCode",
"monthQuotaRequest" : 1,
"dayQuotaRequest" : 6,
"rateRps" : 5,
"quotaCondition" : "quotaCondition"
}
}
응답 상태 코드
API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"stages": [
{
"productName": "product",
"apiName": "api000",
"stageName": "stage",
"stageId": "***5ei7***",
"productId": "***ksk9***",
"apiId": "***51hs***"
}
],
"total": 1,
"usagePlan": {
"domainCode": "PUB"
}
}
이 문서가 도움이 되었습니까?