API Key 구독 조회
- 인쇄
- PDF
API Key 구독 조회
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
API Key와 연결된 Stage(구독 중인 Stage) 정보를 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
GET | /api-keys/{api-key-id}/subscription-detail |
요청 헤더
API Gateway에서 공통으로 사용하는 헤더에 대한 자세한 내용은 API Gateway 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
api-key-id | String | Required | 구독 정보를 조회할 API Key ID |
요청 쿼리 파라미터
파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
offset | Long | Optional | 조회할 데이터 목록에서 시작할 위치
|
limit | Long | Optional | 한 번에 조회할 데이터 개수
|
apiId | String | Optional | Stage가 속한 API ID |
stageId | String | Optional | API Key와 연결된 Stage ID |
productId | String | Required | API Key와 연결된 Product ID |
요청 예시
요청 예시는 다음과 같습니다.
curl -X POST 'https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}/subscription-detail?productId=*****n0bk' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
응답
응답 형식을 설명합니다.
응답 구문
구문은 다음과 같습니다.
{
"apiKeyRelations": {
"content": [
{
"apiId": "apiId",
"apiName": "apiName",
"stageId": "stageId",
"stageName": "stageName",
"apiKeyId": "apiKeyId",
"apiKeyName": "apiKeyName",
"usagePlanId": "usagePlanId",
"usagePlanName": "usagePlanName",
"regTime": "2024-05-07T08:34:37Z",
"modTime": "2024-05-07T08:34:37Z",
"dayCallCount": 0,
"monthCallCount": 0,
"domainCode": "domainCode"
}
],
"total": 0
}
}
응답 상태 코드
API Gateway에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 API Gateway 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"apiKeyRelations": {
"content": [
{
"apiId": "*****uwtk",
"apiName": "api-***",
"stageId": "*****7mhdv",
"stageName": "v1",
"apiKeyId": "*****g079",
"apiKeyName": "apiKey-***",
"usagePlanId": "*****w2111",
"usagePlanName": "usagePlan-***",
"regTime": "2024-05-07T08:34:37Z",
"modTime": "2024-05-07T08:34:37Z",
"dayCallCount": 0,
"monthCallCount": 0,
"domainCode": "PUB"
}
],
"total": 1
}
}
이 문서가 도움이 되었습니까?