Usage Plan이 연결된 Stage 조회
- 인쇄
- PDF
Usage Plan이 연결된 Stage 조회
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
지정한 API에 속한 Stage 중 특정 Usage Plan이 연결된 Stage를 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
POST | /products/{product-id}/apis/{api-id}/stages/search |
요청 헤더
API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
product-id | String | Required | API가 속한 Product ID
|
api-id | String | Required | Stage를 조회할 API ID
|
요청 구문
요청 구문은 다음과 같습니다.
{
"usagePlanId" : "usagePlanId"
}
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
usagePlanId | String | Required | Stage를 조회할 Usage Plan ID
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request POST 'https://apigateway.apigw.fin-ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/stages/search' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"usagePlanId" : "***833g***"
}'
응답
응답 형식을 설명합니다.
응답 구문
응답 구문은 다음과 같습니다.
{
"stages" : [ {
"stageName" : "stageName",
"stageId" : "stageId"
} ]
}
응답 상태 코드
API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"stages": [
{
"stageId": "***fh5o***",
"stageName": "stage000"
},
{
"stageId": "***5ei7***",
"stageName": "stage"
}
]
}
이 문서가 도움이 되었습니까?