Stage 조회
- 인쇄
- PDF
Stage 조회
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
지정한 Stage의 상세 정보를 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
GET | /products/{product-id}/apis/{api-id}/stages/{stage-id} |
요청 헤더
API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
product-id | String | Required | Stage가 속한 Product ID
|
api-id | String | Required | Stage가 속한 API ID
|
stage-id | String | Required | 조회할 Stage ID
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://apigateway.apigw.fin-ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/stages/***fh5o***' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
응답
응답 형식을 설명합니다.
응답 구문
응답 구문은 다음과 같습니다.
{
"stage" : {
"canaryDeployedTime" : "2000-01-23T04:56:07.000+00:00",
"modifier" : "modifier",
"canaryEndpointDomain" : "canaryEndpointDomain",
"canaryThrottleRps" : 5,
"cacheTtlSec" : 0,
"stageName" : "stageName",
"throttleRps" : 4,
"monthQuotaRequest" : 9,
"canaryCacheTtlSec" : 6,
"canaryDistributionRate" : 5.962134,
"apiId" : "apiId",
"stageId" : "stageId",
"deployedStageDeploymentNo" : 7,
"useDistributionRate" : true,
"canaryDeploymentDescription" : "canaryDeploymentDescription",
"dayQuotaRequest" : 2,
"isMaintenance" : true,
"rateRps" : 3,
"endpointDomain" : "endpointDomain",
"ipAclList" : "ipAclList",
"canaryDeploymentNo" : 1,
"regTime" : "2000-01-23T04:56:07.000+00:00",
"response" : "response",
"canaryConditions" : [ {
"parameterName" : "parameterName",
"parameterCode" : "REQUEST_HEADER",
"parameterValue" : "parameterValue"
} ],
"tenantId" : "tenantId",
"ipAclCode" : "ALLOWED",
"statusCode" : 2,
"enabledContentEncoding": true,
"minimumCompressionSize": 0
}
}
응답 상태 코드
API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"stage": {
"tenantId": "***e230cebc1402ba89b148896951***",
"modifier": "***d3020-5bb7-11ec-bfb8-246e96591***",
"stageId": "***fh5o***",
"apiId": "***51hs***",
"stageName": "stage000",
"endpointDomain": "https://test***.test.com",
"deployedStageDeploymentNo": 250***,
"regTime": "2024-05-07T23:48:47Z",
"isMaintenance": false,
"certificateId": "***8e2i***",
"enabledContentEncoding": false
}
}
이 문서가 도움이 되었습니까?