Product
- 인쇄
- PDF
Product
- 인쇄
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Usage Plan 수정
URL
PUT https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/api-keys/{api-key-id}/stages/{stage-id}
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| apiKeyId | path | Y | String | Api Key Id 길이(최대/최소): 0/10 |
| stageId | path | Y | String | Stage Id 길이(최대/최소): 0/10 |
요청 바디
{
"usagePlanId" : "usagePlanId"
}
응답 코드
- 204
응답 바디
- 없음
Product 생성
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products
요청 파라미터
- 없음
요청 바디
{
"subscriptionCode" : "PROTECTED",
"description" : "description",
"productName" : "productName"
}
응답 코드
- 201
응답 바디
{
"product" : {
"invokeId" : "invokeId",
"domainCode" : "domainCode",
"productId" : "productId",
"isPublished" : true,
"modifier" : "modifier",
"permission" : "permission",
"productName" : "productName",
"subscriptionCode" : "PROTECTED",
"isDeleted" : true,
"modTime" : "2000-01-23T04:56:07.000+00:00",
"tenantId" : "tenantId",
"disabled" : true,
"productDescription" : "productDescription",
"actionName" : "actionName",
"zoneCode" : "PUBLIC"
}
}
Product 삭제
URL
DELETE https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
요청 바디
- 없음
응답 코드
- 204
응답 바디
- 없음
Product 검색
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
요청 바디
- 없음
응답 코드
- 200
응답 바디
{
"product" : {
"invokeId" : "invokeId",
"domainCode" : "domainCode",
"productId" : "productId",
"isPublished" : true,
"modifier" : "modifier",
"permission" : "permission",
"productName" : "productName",
"subscriptionCode" : "PROTECTED",
"isDeleted" : true,
"modTime" : "2000-01-23T04:56:07.000+00:00",
"tenantId" : "tenantId",
"disabled" : true,
"productDescription" : "productDescription",
"actionName" : "actionName"
}
}
Product 조회
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| offset | query string | N | Long | Offset 최소: 0 최대: 9,223,372,036,854,775,807 |
| limit | query string | N | Long | Limit 최소: 1 최대: 9,223,372,036,854,775,807 |
| productName | query string | N | String | Product Name 길이(최대/최소): 0/100 |
| isPublished | query string | N | Boolean | Is Published |
| subscriptionCode | query string | N | String | Subscription Code 허용 가능한 값: PROTECTED, PUBLIC |
| hasDeployedStage | query string | N | Boolean | Has Deployed Stage |
| hasStageNotAssociatedWithUsagePlanId | query string | N | String | Has Stage Not Associated With Usage Plan Id |
요청 바디
- 없음
응답 코드
- 200
응답 바디
{
"initialCount" : 0,
"productPage" : {
"total" : 6,
"content" : [ {
"invokeId" : "invokeId",
"domainCode" : "domainCode",
"productId" : "productId",
"isPublished" : true,
"modifier" : "modifier",
"permission" : "permission",
"productName" : "productName",
"hasDeployedStage" : true,
"subscriptionCode" : "PROTECTED",
"isDeleted" : true,
"modTime" : "2000-01-23T04:56:07.000+00:00",
"tenantId" : "tenantId",
"disabled" : true,
"productDescription" : "productDescription",
"actionName" : "actionName"
} ]
}
}
Product 수정
URL
PATCH https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
요청 바디
{
"subscriptionCode" : "PROTECTED",
"description" : "description",
"productName" : "productName"
}
응답 코드
- 204
응답 바디
- 없음
API Key 목록 검색
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/api-keys/search
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
요청 바디
{
"apiKeyValue" : "apiKeyValue",
"offset" : 6,
"limit" : 0,
"apiKeyId" : "apiKeyId",
"statusSet" : [ "REQUEST" ]
}
응답 코드
- 200
응답 바디
{
"apiKeyPage" : {
"total" : 0,
"content" : [ {
"domainCode" : "domainCode",
"regTime" : "2000-01-23T04:56:07.000+00:00",
"secondaryKey" : "secondaryKey",
"modTime" : "2000-01-23T04:56:07.000+00:00",
"apiKeyId" : "apiKeyId",
"apiKeyName" : "apiKeyName",
"primaryKey" : "primaryKey",
"status" : "REQUEST"
} ]
}
}
Product 문서 검색
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/document
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| offset | query string | N | Long | Offset 최소: 0 최대: 9,223,372,036,854,775,807 |
| limit | query string | N | Long | Limit 최소: 1 최대: 9,223,372,036,854,775,807 |
| apiName | query string | N | String | Api Name 길이(최대/최소): 0/20 |
요청 바디
- 없음
응답 코드
- 200
응답 바디
{
"apiPage" : {
"total" : 6,
"content" : [ {
"apiName" : "apiName",
"domainCode" : "domainCode",
"stages" : [ {
"deployedStageDeploymentNo" : 0,
"stageName" : "stageName",
"host" : "host",
"stageId" : "stageId"
} ],
"apiDescription" : "apiDescription",
"apiId" : "apiId"
} ]
}
}
Product Overview 검색
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/overview
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
요청 바디
- 없음
응답 코드
- 200
응답 바디
{
"apis" : [ {
"apiName" : "apiName",
"domainCode" : "domainCode",
"methodsCount" : 2,
"stages" : [ {
"deployedStageDeploymentNo" : 0,
"stageName" : "stageName",
"host" : "host",
"stageId" : "stageId"
} ],
"apiId" : "apiId"
} ],
"apiKeyCountInfo" : {
"request" : 5,
"total" : 5,
"rejected" : 1,
"accepted" : 0,
"denied" : 6
}
}
Product 구독 조회
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/subscription-detail
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| offset | query string | N | Long | Offset 최소: 0 최대: 9,223,372,036,854,775,807 |
| limit | query string | N | Long | Limit 최소: 1 최대: 9,223,372,036,854,775,807 |
| apiId | query string | N | String | Api Id 길이(최대/최소): 0/10 |
| stageId | query string | N | String | Stage Id 길이(최대/최소): 0/10 |
| apiKeyId | query string | Y | String | Api Key Id 길이(최대/최소): 0/10 |
요청 바디
- 없음
응답 코드
- 200
응답 바디
{
"apiKeyRelations" : {
"total" : 5,
"content" : [ {
"apiName" : "apiName",
"domainCode" : "domainCode",
"monthlyUsage" : 5,
"usagePlanId" : "usagePlanId",
"monthCallCount" : 1,
"apiKeyId" : "apiKeyId",
"apiKeyName" : "apiKeyName",
"usagePlanName" : "usagePlanName",
"dailyUsage" : 0,
"regTime" : "2000-01-23T04:56:07.000+00:00",
"stageName" : "stageName",
"modTime" : "2000-01-23T04:56:07.000+00:00",
"dayCallCount" : 6,
"apiId" : "apiId",
"stageId" : "stageId"
} ]
}
}
구독 상태 수정
URL
PATCH https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/api-keys/{api-key-id}
요청 파라미터
| 이름 | 위치 | 필수여부 | 타입 | 설명 |
|---|---|---|---|---|
| productId | path | Y | String | Product Id 길이(최대/최소): 0/10 |
| apiKeyId | path | Y | String | Api Key Id 길이(최대/최소): 0/10 |
요청 바디
{
"status" : "ACCEPTED"
}
응답 코드
- 204
응답 바디
- 없음
이 문서가 도움이 되었습니까?