Application Service

• 1: API Gateway
• 1.1: APIs
• 1.1.1: Approve PrivateLink Endpoint
• 1.1.1.1: 1.3
• 1.1.1.2: 1.2
• 1.1.2: Connect PrivateLink Endpoint
• 1.1.2.1: 1.3
• 1.1.2.2: 1.2
• 1.1.3: Create AccessControl
• 1.1.3.1: 1.3
• 1.1.3.2: 1.2
• 1.1.3.3: 1.1
• 1.1.3.4: 1.0
• 1.1.4: Create Api
• 1.1.4.1: 1.3
• 1.1.4.2: 1.2
• 1.1.4.3: 1.1
• 1.1.4.4: 1.0
• 1.1.5: Create Api Deployment
• 1.1.5.1: 1.3
• 1.1.5.2: 1.2
• 1.1.5.3: 1.1
• 1.1.5.4: 1.0
• 1.1.6: Create Api Key
• 1.1.6.1: 1.3
• 1.1.6.2: 1.2
• 1.1.6.3: 1.1
• 1.1.7: Create Auth
• 1.1.7.1: 1.3
• 1.1.7.2: 1.2
• 1.1.7.3: 1.1
• 1.1.7.4: 1.0
• 1.1.8: Create Method
• 1.1.8.1: 1.3
• 1.1.8.2: 1.2
• 1.1.8.3: 1.1
• 1.1.8.4: 1.0
• 1.1.9: Create PrivateLink Endpoint
• 1.1.9.1: 1.3
• 1.1.9.2: 1.2
• 1.1.10: Create Resource
• 1.1.10.1: 1.3
• 1.1.10.2: 1.2
• 1.1.10.3: 1.1
• 1.1.10.4: 1.0
• 1.1.11: Create Stage
• 1.1.11.1: 1.3
• 1.1.11.2: 1.2
• 1.1.11.3: 1.1
• 1.1.11.4: 1.0
• 1.1.12: Create Usage Plans
• 1.1.12.1: 1.3
• 1.1.12.2: 1.2
• 1.1.12.3: 1.1
• 1.1.13: Delete Access Control
• 1.1.13.1: 1.3
• 1.1.13.2: 1.2
• 1.1.13.3: 1.1
• 1.1.13.4: 1.0
• 1.1.14: Delete an API Key
• 1.1.14.1: 1.3
• 1.1.14.2: 1.2
• 1.1.14.3: 1.1
• 1.1.15: Delete Api
• 1.1.15.1: 1.3
• 1.1.15.2: 1.2
• 1.1.15.3: 1.1
• 1.1.15.4: 1.0
• 1.1.16: Delete Auth
• 1.1.16.1: 1.3
• 1.1.16.2: 1.2
• 1.1.16.3: 1.1
• 1.1.16.4: 1.0
• 1.1.17: Delete Method
• 1.1.17.1: 1.3
• 1.1.17.2: 1.2
• 1.1.17.3: 1.1
• 1.1.17.4: 1.0
• 1.1.18: Delete PrivateLink Endpoint
• 1.1.18.1: 1.3
• 1.1.18.2: 1.2
• 1.1.19: Delete Resource
• 1.1.19.1: 1.3
• 1.1.19.2: 1.2
• 1.1.19.3: 1.1
• 1.1.19.4: 1.0
• 1.1.20: Delete Resource Policy
• 1.1.20.1: 1.3
• 1.1.21: Delete Stage
• 1.1.21.1: 1.3
• 1.1.21.2: 1.2
• 1.1.21.3: 1.1
• 1.1.21.4: 1.0
• 1.1.22: Delete Usage Plan
• 1.1.22.1: 1.3
• 1.1.22.2: 1.2
• 1.1.22.3: 1.1
• 1.1.23: List AccessControls
• 1.1.23.1: 1.3
• 1.1.23.2: 1.2
• 1.1.23.3: 1.1
• 1.1.23.4: 1.0
• 1.1.24: List Api Deployments
• 1.1.24.1: 1.3
• 1.1.24.2: 1.2
• 1.1.24.3: 1.1
• 1.1.24.4: 1.0
• 1.1.25: List Api Keys
• 1.1.25.1: 1.3
• 1.1.25.2: 1.2
• 1.1.25.3: 1.1
• 1.1.26: List Apis
• 1.1.26.1: 1.3
• 1.1.26.2: 1.2
• 1.1.26.3: 1.1
• 1.1.26.4: 1.0
• 1.1.27: List Auths
• 1.1.27.1: 1.3
• 1.1.27.2: 1.2
• 1.1.27.3: 1.1
• 1.1.27.4: 1.0
• 1.1.28: List Connected PrivateLink Endpoints
• 1.1.28.1: 1.3
• 1.1.28.2: 1.2
• 1.1.29: List Methods
• 1.1.29.1: 1.3
• 1.1.29.2: 1.2
• 1.1.29.3: 1.1
• 1.1.29.4: 1.0
• 1.1.30: List PrivateLink Endpoints
• 1.1.30.1: 1.3
• 1.1.30.2: 1.2
• 1.1.31: List Reports
• 1.1.31.1: 1.3
• 1.1.31.2: 1.2
• 1.1.31.3: 1.1
• 1.1.32: List Resources
• 1.1.32.1: 1.3
• 1.1.32.2: 1.2
• 1.1.32.3: 1.1
• 1.1.32.4: 1.0
• 1.1.33: List Stages
• 1.1.33.1: 1.3
• 1.1.33.2: 1.2
• 1.1.33.3: 1.1
• 1.1.33.4: 1.0
• 1.1.34: List Usage Plans
• 1.1.34.1: 1.3
• 1.1.34.2: 1.2
• 1.1.34.3: 1.1
• 1.1.35: Request PrivateLink Endpoint
• 1.1.35.1: 1.3
• 1.1.35.2: 1.2
• 1.1.36: Set Access Control
• 1.1.36.1: 1.3
• 1.1.36.2: 1.2
• 1.1.36.3: 1.1
• 1.1.36.4: 1.0
• 1.1.37: Set Api Description
• 1.1.37.1: 1.3
• 1.1.37.2: 1.2
• 1.1.37.3: 1.1
• 1.1.37.4: 1.0
• 1.1.38: Set API Key Description
• 1.1.38.1: 1.3
• 1.1.38.2: 1.2
• 1.1.38.3: 1.1
• 1.1.39: Set Auth
• 1.1.39.1: 1.3
• 1.1.39.2: 1.2
• 1.1.39.3: 1.1
• 1.1.39.4: 1.0
• 1.1.40: Set Method
• 1.1.40.1: 1.3
• 1.1.40.2: 1.2
• 1.1.40.3: 1.1
• 1.1.40.4: 1.0
• 1.1.41: Set PrivateLink Endpoint
• 1.1.41.1: 1.3
• 1.1.41.2: 1.2
• 1.1.42: Set Resource Policy
• 1.1.42.1: 1.3
• 1.1.43: Set Stage Active Deployment
• 1.1.43.1: 1.3
• 1.1.43.2: 1.2
• 1.1.43.3: 1.1
• 1.1.43.4: 1.0
• 1.1.44: Set Stage Configuration
• 1.1.44.1: 1.3
• 1.1.44.2: 1.2
• 1.1.44.3: 1.1
• 1.1.44.4: 1.0
• 1.1.45: Set Usage Plan Description
• 1.1.45.1: 1.3
• 1.1.45.2: 1.2
• 1.1.45.3: 1.1
• 1.1.46: Set Usage Plan Quota
• 1.1.46.1: 1.3
• 1.1.46.2: 1.2
• 1.1.46.3: 1.1
• 1.1.47: Show Access Control
• 1.1.47.1: 1.3
• 1.1.47.2: 1.2
• 1.1.47.3: 1.1
• 1.1.47.4: 1.0
• 1.1.48: Show Api
• 1.1.48.1: 1.3
• 1.1.48.2: 1.2
• 1.1.48.3: 1.1
• 1.1.48.4: 1.0
• 1.1.49: Show Auth
• 1.1.49.1: 1.3
• 1.1.49.2: 1.2
• 1.1.49.3: 1.1
• 1.1.49.4: 1.0
• 1.1.50: Show Method
• 1.1.50.1: 1.3
• 1.1.50.2: 1.2
• 1.1.50.3: 1.1
• 1.1.50.4: 1.0
• 1.1.51: Show PrivateLink Endpoint
• 1.1.51.1: 1.3
• 1.1.51.2: 1.2
• 1.1.52: Show Resource
• 1.1.52.1: 1.3
• 1.1.52.2: 1.2
• 1.1.52.3: 1.1
• 1.1.52.4: 1.0
• 1.1.53: Show Resource Policy
• 1.1.53.1: 1.3
• 1.1.54: Show Stage
• 1.1.54.1: 1.3
• 1.1.54.2: 1.2
• 1.1.54.3: 1.1
• 1.1.54.4: 1.0
• 1.1.55: Show Usage Plan
• 1.1.55.1: 1.3
• 1.1.55.2: 1.2
• 1.1.55.3: 1.1
• 1.2: Models
• 1.2.1: AccessControl
• 1.2.2: AccessControlCreateRequest
• 1.2.3: AccessControlCreateResponse
• 1.2.4: AccessControlListResponse
• 1.2.5: AccessControlSetRequest
• 1.2.6: AccessControlShowResponse
• 1.2.7: Api
• 1.2.8: ApiConnectedEndpoint
• 1.2.9: ApiConnectedEndpointListResponse
• 1.2.10: ApiCreateRequest
• 1.2.11: ApiCreateRequestV1Dot2
• 1.2.12: ApiCreateResponse
• 1.2.13: ApiDeployment
• 1.2.14: ApiDeploymentListResponse
• 1.2.15: ApiDeploymentRequest
• 1.2.16: ApiDeploymentResponse
• 1.2.17: ApiDetail
• 1.2.18: ApiKey
• 1.2.19: ApiKeyCreateRequest
• 1.2.20: ApiKeyInStage
• 1.2.21: ApiKeyListResponse
• 1.2.22: ApiKeySetDescriptionRequest
• 1.2.23: ApiKeyShowResponse
• 1.2.24: ApiListResponse
• 1.2.25: ApiSetDescriptionRequest
• 1.2.26: ApiShowResponse
• 1.2.27: Auth
• 1.2.28: AuthCreateRequest
• 1.2.29: AuthCreateResponse
• 1.2.30: AuthListResponse
• 1.2.31: AuthSetRequest
• 1.2.32: AuthShowResponse
• 1.2.33: Method
• 1.2.34: MethodCreateRequest
• 1.2.35: MethodCreateRequestV1Dot1
• 1.2.36: MethodCreateRequestV1Dot2
• 1.2.37: MethodCreateRequestV1Dot3
• 1.2.38: MethodInStage
• 1.2.39: MethodInStageV1Dot3
• 1.2.40: MethodListResponse
• 1.2.41: MethodListResponseV1Dot1
• 1.2.42: MethodListResponseV1Dot2
• 1.2.43: MethodListResponseV1Dot3
• 1.2.44: MethodSetRequest
• 1.2.45: MethodSetRequestV1Dot1
• 1.2.46: MethodSetRequestV1Dot2
• 1.2.47: MethodSetRequestV1Dot3
• 1.2.48: MethodShowResponse
• 1.2.49: MethodShowResponseV1Dot1
• 1.2.50: MethodShowResponseV1Dot2
• 1.2.51: MethodShowResponseV1Dot3
• 1.2.52: MethodV1Dot1
• 1.2.53: MethodV1Dot2
• 1.2.54: MethodV1Dot3
• 1.2.55: PolicyDocument
• 1.2.56: PrivateLinkEndpoint
• 1.2.57: PrivateLinkEndpointApprovalRequest
• 1.2.58: PrivateLinkEndpointConnectionRequest
• 1.2.59: PrivateLinkEndpointCreateRequest
• 1.2.60: PrivateLinkEndpointDetail
• 1.2.61: PrivateLinkEndpointListResponse
• 1.2.62: PrivateLinkEndpointRequestRequest
• 1.2.63: PrivateLinkEndpointSetRequest
• 1.2.64: PrivateLinkEndpointShowResponse
• 1.2.65: PrivateLinkEndpointSummary
• 1.2.66: PrivateLinkEndpointSummaryShowResponse
• 1.2.67: Report
• 1.2.68: ReportListResponse
• 1.2.69: Resource
• 1.2.70: ResourceCreateRequest
• 1.2.71: ResourceCreateResponse
• 1.2.72: ResourceListResponse
• 1.2.73: ResourceListResponseV1Dot1
• 1.2.74: ResourceListResponseV1Dot2
• 1.2.75: ResourceListResponseV1Dot3
• 1.2.76: ResourcePolicySetRequest
• 1.2.77: ResourcePolicyShowResponse
• 1.2.78: ResourceShowResponse
• 1.2.79: ResourceShowResponseV1Dot1
• 1.2.80: ResourceShowResponseV1Dot2
• 1.2.81: ResourceShowResponseV1Dot3
• 1.2.82: ResourceSummary
• 1.2.83: ResourceSummaryV1Dot1
• 1.2.84: ResourceSummaryV1Dot3
• 1.2.85: ResourceV1Dot1
• 1.2.86: ResourceV1Dot2
• 1.2.87: ResourceV1Dot3
• 1.2.88: Stage
• 1.2.89: StageCreateRequest
• 1.2.90: StageDetail
• 1.2.91: StageDetailV1Dot1
• 1.2.92: StageDetailV1Dot3
• 1.2.93: StageListResponse
• 1.2.94: StageListResponseV1Dot1
• 1.2.95: StageListResponseV1Dot3
• 1.2.96: StageSetActiveDeploymentRequest
• 1.2.97: StageSetConfigRequest
• 1.2.98: StageSetConfigRequestV1Dot1
• 1.2.99: StageShowResponse
• 1.2.100: StageShowResponseV1Dot1
• 1.2.101: StageShowResponseV1Dot3
• 1.2.102: StageV1Dot1
• 1.2.103: StageV1Dot3
• 1.2.104: Statement
• 1.2.105: Tag
• 1.2.106: TopResource
• 1.2.107: UsagePlan
• 1.2.108: UsagePlanCreateRequest
• 1.2.109: UsagePlanDetail
• 1.2.110: UsagePlanListResponse
• 1.2.111: UsagePlanSetDescriptionRequest
• 1.2.112: UsagePlanSetQuotaRequest
• 1.2.113: UsagePlanShowResponse
• 2: Queue Service
• 2.1: APIs
• 2.1.1: Check Queue Name Duplication
• 2.1.1.1: 1.2
• 2.1.1.2: 1.1
• 2.1.1.3: 1.0
• 2.1.2: Create Queue
• 2.1.2.1: 1.2
• 2.1.2.2: 1.1
• 2.1.2.3: 1.0
• 2.1.3: Delete Acl
• 2.1.3.1: 1.2
• 2.1.3.2: 1.1
• 2.1.3.3: 1.0
• 2.1.4: Delete Queue
• 2.1.4.1: 1.2
• 2.1.4.2: 1.1
• 2.1.4.3: 1.0
• 2.1.5: Get Queue Attributes
• 2.1.5.1: 1.2
• 2.1.5.2: 1.1
• 2.1.6: List Queue
• 2.1.6.1: 1.2
• 2.1.6.2: 1.1
• 2.1.6.3: 1.0
• 2.1.7: Set Acl
• 2.1.7.1: 1.2
• 2.1.7.2: 1.1
• 2.1.7.3: 1.0
• 2.1.8: Show Queue
• 2.1.8.1: 1.2
• 2.1.8.2: 1.1
• 2.1.8.3: 1.0
• 2.1.9: Update Queue Config
• 2.1.9.1: 1.2
• 2.1.9.2: 1.1
• 2.1.9.3: 1.0
• 2.1.10: Update Queue Deduplication
• 2.1.10.1: 1.2
• 2.1.11: Update Queue Deduplication Scope
• 2.1.11.1: 1.2
• 2.1.12: Update Queue Description
• 2.1.12.1: 1.2
• 2.1.12.2: 1.1
• 2.1.12.3: 1.0
• 2.2: Models
• 2.2.1: Acl
• 2.2.2: AclRequest
• 2.2.3: AclResponse
• 2.2.4: CheckDuplicationResponse
• 2.2.5: ConfigSetRequest
• 2.2.6: DeduplicationScopeSetRequest
• 2.2.7: DeduplicationSetRequest
• 2.2.8: DescriptionSetRequest
• 2.2.9: DescriptionSetResponse
• 2.2.10: Encryption
• 2.2.11: GetAttribute
• 2.2.12: GetAttributesResponse
• 2.2.13: Queue
• 2.2.14: QueueCreateRequest
• 2.2.15: QueueCreateRequestV1_2
• 2.2.16: QueueCreateResponse
• 2.2.17: QueueListResponseV1_0
• 2.2.18: QueueListResponseV1_1
• 2.2.19: QueueShowResponseV1_0
• 2.2.20: QueueShowResponseV1_1
• 2.2.21: QueueShowResponseV1_2
• 2.2.22: Tag

1 - API Gateway

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 응용 프로그램 인터페이스(Application Programming Interface, API)를 제공합니다.

본 가이드는 API Gateway 서비스에 대한 간략한 설명 및 API를 호출하는 방법을 제공합니다. API는 RESTful API 방식으로 제공되며, JSON 형식으로 응답합니다.

Version

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

OpenAPI URL

https://apigateway.{region}.{environment}.samsungsdscloud.com

Environment and Region List

API Version History

1.3

리소스 정책 기능이 추가되었습니다.
List Resources API의 응답이 변경되었습니다.
Get Resource API의 응답이 변경되었습니다.
List Methods API의 응답이 변경되었습니다.
Create Method API의 요청이 변경되었습니다.
Set Method API의 요청이 변경되었습니다.
Get Method API의 응답이 변경되었습니다.
List Stages API의 응답이 변경되었습니다.
Get Stage API의 응답이 변경되었습니다.

변경사항

• [신규] GET /apis/{api_id}/resource-policies - Show Resource Policy API가 추가되었습니다.
• [신규] PUT /apis/{api_id}/resource-policies - Set Resource Policy API가 추가되었습니다.
• [신규] DELETE /apis/{api_id}/resource-policies - Delete Resource Policy API가 추가되었습니다.
• [변경] GET /apis/{api_id}/resources - 응답 시, 아래와 같은 필드가 추가됩니다.
  • iam_enabled
• [변경] GET /apis/{api_id}/resources/{resource_id} - 응답 시, 아래와 같은 필드가 추가됩니다.
  • iam_enabled
• [변경] GET /apis/{api_id}/resources/{resource_id}/methods - 응답 시, 아래와 같은 필드가 추가됩니다.
  • iam_enabled
• [변경] POST /apis/{api_id}/resources/{resource_id}/methods - 요청 시, 아래와 같은 필드가 추가됩니다.
  • iam_enabled
• [변경] PUT /apis/{api_id}/resources/{resource_id}/methods/{method_type} - 요청 시, 아래와 같은 필드가 추가됩니다.
  • iam_enabled
• [변경] GET /apis/{api_id}/resources/{resource_id}/methods/{method_type} - 응답 시, 아래와 같은 필드가 추가됩니다.
  • iam_enabled
• [변경] GET /apis/{api_id}/stages - 응답 시, 아래와 같은 필드가 추가됩니다.
  • description
  • api_key_required
  • usage_plan_name
  • uesage_plan_id
  • usage_plan_rate
  • usage_plan_limit
  • usage_plan_api_keys
• [변경] GET /apis/{api_id}/stages - 응답 시, 아래와 같은 필드가 삭제됩니다.
  • api_key_required
• [변경] GET /apis/{api_id}/stages - 응답 시, methods 필드의 형태가 아래처럼 변경됩니다.
  • 기존 "methods": [{"type": GET", "api_key_required": true}]
  • 변경 "methods": [{"type": GET", "api_key_required": true, "iam_enabled": true}]
• [변경] GET /apis/{api_id}/stages/{stage_name} - 응답 시, 아래와 같은 필드가 삭제됩니다.
  • api_key_required

1.2

PrivateLink 기능이 추가되었습니다.
List Apis API의 응답이 변경되었습니다.
Create Api API의 요청이 변경되었습니다.
Get Api API의 응답이 변경되었습니다.
List Resources API의 응답이 변경되었습니다.
Get Resource API의 응답이 변경되었습니다.
List Methods API의 응답이 변경되었습니다.
Create Method API의 요청이 변경되었습니다.
Set Method API의 요청이 변경되었습니다.
Get Method API의 응답이 변경되었습니다.

변경사항

• [신규] GET /apis/{api_id}/connected-endpoints - List Connected PrivateLink Endpoints API가 추가되었습니다.
• [신규] GET /privatelink-endpoints - List PrivateLink Endpoints API가 추가되었습니다.
• [신규] POST /privatelink-endpoints - Create PrivateLink Endpoint API가 추가되었습니다.
• [신규] DELETE /privatelink-endpoints/{privatelink_endpoint_id} - Delete PrivateLink Endpoint API가 추가되었습니다.
• [신규] PUT /privatelink-endpoints/{privatelink_endpoint_id} - Set PrivateLink Endpoint API가 추가되었습니다.
• [신규] PUT /privatelink-endpoints/{privatelink_endpoint_id}/approval - Approve PrivateLink Endpoint API가 추가되었습니다.
• [신규] PUT /privatelink-endpoints/{privatelink_endpoint_id}/connection - Connect PrivateLink Endpoint API가 추가되었습니다.
• [신규] PUT /privatelink-endpoints/{privatelink_endpoint_id}/request - Request PrivateLink Endpoint API가 추가되었습니다.
• [신규] GET /privatelink-endpoints/{privatelink_endpoint_id} - Show PrivateLink Endpoint API가 추가되었습니다.
• [변경] GET /apis - 응답 시, 아래와 같은 필드가 추가됩니다.
  • endpoint_type
• [변경] POST /apis - 요청 시, 아래와 같은 필드가 추가됩니다.
  • endpoint_type
• [변경] GET /apis/{api_id} - 응답 시, 아래와 같은 필드가 추가됩니다.
  • endpoint_type
  • privatelink_service_id
• [변경] GET /apis/{api_id}/resources - 응답 시, 아래와 같은 필드가 추가됩니다.
  • privatelink_endpoint_id
• [변경] GET /apis/{api_id}/resources/{resource_id} - 응답 시, 아래와 같은 필드가 추가됩니다.
  • privatelink_endpoint_id
• [변경] GET /apis/{api_id}/resources/{resource_id}/methods - 응답 시, 아래와 같은 필드가 추가됩니다.
  • privatelink_endpoint_id
• [변경] POST /apis/{api_id}/resources/{resource_id}/methods - 요청 시, 아래와 같은 필드가 추가됩니다.
  • privatelink_endpoint_id
• [변경] PUT /apis/{api_id}/resources/{resource_id}/methods/{method_type} - 요청 시, 아래와 같은 필드가 추가됩니다.
  • privatelink_endpoint_id
• [변경] GET /apis/{api_id}/resources/{resource_id}/methods/{method_type} - 응답 시, 아래와 같은 필드가 추가됩니다.
  • privatelink_endpoint_id

1.1

사용량 정책 기능이 추가되었습니다.
API Key 관리 기능이 추가되었습니다.
Report 기능이 추가되었습니다.
List Resources API의 응답이 변경되었습니다.
Get Resource API의 응답이 변경되었습니다.
List Methods API의 응답이 변경되었습니다.
Create Method API의 요청이 변경되었습니다.
Set Method API의 요청이 변경되었습니다.
Get Method API의 응답이 변경되었습니다.
List Stages API의 응답이 변경되었습니다.
Set Stage Configuration API의 요청이 변경되었습니다.
Get Stage API의 응답이 변경되었습니다.

변경사항

• [신규] GET /apis/{api_id}/usage-palns - List Usage Plans API가 추가되었습니다.
• [신규] POST /apis/{api_id}/usage-palns - Create Usage Plan API가 추가되었습니다.
• [신규] PUT /apis/{api_id}/usage-plans/{usage_plan_id}/description - Set Usage Plan Description API가 추가되었습니다.
• [신규] PUT /apis/{api_id}/usage-plans/{usage_plan_id}/quota - Set Usage Plan Quota API가 추가되었습니다.
• [신규] DELETE /apis/{api_id}/usage-plans/{usage_plan_id} - Delete Usage Plan API가 추가되었습니다.
• [신규] GET /apis/{api_id}/usage-plans/{usage_plan_id} - Show Usage Plan API가 추가되었습니다.
• [신규] GET /apis/{api_id}/usage-palns/{usage_plan_id}/api-keys - List Api Keys API가 추가되었습니다.
• [신규] POST /apis/{api_id}/usage-palns/{usage_plan_id}/api-keys - Create APi Key API가 추가되었습니다.
• [신규] PUT /apis/{api_id}/usage-plans/{usage_plan_id}/api-keys/{api_key_id}/description - Set Api Key Description API가 추가되었습니다.
• [신규] DELETE /apis/{api_id}/usage-plans/{usage_plan_id}/api-keys/{api_key_id} - Delete Api Key API가 추가되었습니다.
• [신규] GET /apis/{api_id}/reports - List Reports API가 추가되었습니다.
• [변경] GET /apis/{api_id}/resources - 응답 시, 아래와 같은 필드가 추가됩니다.
  • function_name
  • api_key_required
• [변경] GET /apis/{api_id}/resources/{resource_id} - 응답 시, 아래와 같은 필드가 추가됩니다.
  • function_name
  • api_key_required
• [변경] GET /apis/{api_id}/resources/{resource_id}/methods - 응답 시, 아래와 같은 필드가 추가됩니다.
  • function_name
  • api_key_required
• [변경] POST /apis/{api_id}/resources/{resource_id}/methods - 요청 시, 아래와 같은 필드가 추가됩니다.
  • api_key_required
• [변경] PUT /apis/{api_id}/resources/{resource_id}/methods/{method_type} - 요청 시, 아래와 같은 필드가 추가됩니다.
  • api_key_required
  • endpoint_url
  • function_id
  • integration_type
• [변경] GET /apis/{api_id}/resources/{resource_id}/methods/{method_type} - 응답 시, 아래와 같은 필드가 추가됩니다.
  • function_name
  • api_key_required
• [변경] GET /apis/{api_id}/stages - 응답 시, 아래와 같은 필드가 추가됩니다.
  • description
  • api_key_required
  • usage_plan_name
  • uesage_plan_id
  • usage_plan_rate
  • usage_plan_limit
  • usage_plan_api_keys
• [변경] GET /apis/{api_id}/stages - 응답 시, 아래와 같은 필드가 삭제됩니다.
  • ip_restriction_enabled
• [변경] GET /apis/{api_id}/stages - 응답 시, methods 필드의 형태가 아래처럼 변경됩니다.
  • 기존 "methods": ["GET", "POST"]
  • 변경 "methods": [{"type": GET", "api_key_required": true}]
• [변경] PUT /apis/{api_id}/stages/{stage_name}/config - 요청 시, 아래와 같은 필드가 추가됩니다.
  • description
  • usage_plan_id
  • connected_api_keys
• [변경] PUT /apis/{api_id}/stages/{stage_name}/config - 요청 시, 아래와 같은 필드가 삭제됩니다.
  • ip_restriction_enabled
• [변경] GET /apis/{api_id}/stages/{stage_name} - 응답 시, 아래와 같은 필드가 추가됩니다.
  • description
  • api_key_required
  • usage_plan_name
  • uesage_plan_id
  • usage_plan_rate
  • usage_plan_limit
  • usage_plan_api_keys
• [변경] GET /apis/{api_id}/stages/{stage_name} - 응답 시, 아래와 같은 필드가 삭제됩니다.
  • ip_restriction_enabled

1.0

API Gateway가 출시되었습니다.

변경사항

• [신규] GET /apis - List APis API가 추가되었습니다.
• [신규] POST /apis - Create Api API가 추가되었습니다.
• [신규] PUT /apis/{api_id}/description - Set Api Description API가 추가되었습니다.
• [신규] DELETE /apis/{api_id} - Delete Api API가 추가되었습니다.
• [신규] GET /apis/{api_id} - Show Api API가 추가되었습니다.
• [신규] GET /apis/{api_id}/deployments - List Api Deployments API가 추가되었습니다.
• [신규] POST /apis/{api_id}/deployments - Create Api Deployment API가 추가되었습니다.
• [신규] GET /apis/{api_id}/resources - List Resources API가 추가되었습니다.
• [신규] POST /apis/{api_id}/resources/{parent_id} - Create Resource API가 추가되었습니다.
• [신규] DELETE /apis/{api_id}/resources/{resource_id} - Delete Resource API가 추가되었습니다.
• [신규] GET /apis/{api_id}/resources/{resource_id} - Show Resource API가 추가되었습니다.
• [신규] GET /apis/{api_id}/resources/{resource_id}/methods - List Methods API가 추가되었습니다.
• [신규] POST /apis/{api_id}/resources/{resource_id}/methods - Create Method API가 추가되었습니다.
• [신규] PUT /apis/{api_id}/resources/{resource_id}/methods/{method_type} - Set Method API가 추가되었습니다.
• [신규] DELETE /apis/{api_id}/resources/{resource_id}/methods/{method_type} - Delete Method API가 추가되었습니다.
• [신규] GET /apis/{api_id}/resources/{resource_id}/methods/{method_type} - Show Method API가 추가되었습니다.
• [신규] GET /apis/{api_id}/stages - List Stages API가 추가되었습니다.
• [신규] POST /apis/{api_id}/stages - Create Stage API가 추가되었습니다.
• [신규] DELETE /apis/{api_id}/stages/{stage_name} - Delete Stage API가 추가되었습니다.
• [신규] GET /apis/{api_id}/stages/{stage_name} - Show Stage API가 추가되었습니다.
• [신규] PUT /apis/{api_id}/stages/{stage_name}/deployment - Set Stage Active Deployment API가 추가되었습니다.
• [신규] PUT /apis/{api_id}/stages/{stage_name}/config - Set Stage Configuration API가 추가되었습니다.
• [신규] GET /apis/{api_id}/auths - List Auths API가 추가되었습니다.
• [신규] POST /apis/{api_id}/auths - Create Auth API가 추가되었습니다.
• [신규] PUT /apis/{api_id}/auths/{auth_id} - Set Auth API가 추가되었습니다.
• [신규] DELETE /apis/{api_id}/auths/{auth_id} - Delete Auth API가 추가되었습니다.
• [신규] GET /apis/{api_id}/auths/{auth_id} - Show Auth API가 추가되었습니다.
• [신규] GET /apis/{api_id}/access-controls - List AccessControls API가 추가되었습니다.
• [신규] POST /apis/{api_id}/access-controls - Create AccessControl API가 추가되었습니다.
• [신규] PUT /apis/{api_id}/access-controls/{access_control_id} - Set AccessControl API가 추가되었습니다.
• [신규] DELETE /apis/{api_id}/access-controls/{access_control_id} - Delete AccessControl API가 추가되었습니다.
• [신규] GET /apis/{api_id}/access-controls/{access_control_id} - Show AccessControl API가 추가되었습니다.

1.1 - APIs

1.1.1 - Approve PrivateLink Endpoint

1.1.1.1 - 1.3

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/approval

Description

PrivateLink 엔드포인트를 승인한다

상태 ACTIVE (CURRENT)

Parameters

Responses

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}/approval

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.3"

Request body

{
    "api_id": "27bb070b564349f8a31cc60734cc36a5",
    "type": "CANCEL"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2024-05-17T00:23:17Z",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "status": "Active"
    }
}

1.1.1.2 - 1.2

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/approval

Description

PrivateLink 엔드포인트를 승인한다

상태 ACTIVE (SUPPORTED)

Parameters

Responses

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}/approval

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "api_id": "27bb070b564349f8a31cc60734cc36a5",
    "type": "CANCEL"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2024-05-17T00:23:17Z",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "status": "Active"
    }
}

1.1.2 - Connect PrivateLink Endpoint

1.1.2.1 - 1.3

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/connection

Description

PrivateLink 엔드포인트를 연결한다

상태 ACTIVE (CURRENT)

Parameters

Responses

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}/connection

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.3"

Request body

{
    "api_id": "27bb070b564349f8a31cc60734cc36a5",
    "type": "CANCEL"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2024-05-17T00:23:17Z",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "status": "Active"
    }
}

1.1.2.2 - 1.2

put /v1/privatelink-endpoints/{privatelink_endpoint_id}/connection

Description

PrivateLink 엔드포인트를 연결한다

상태 ACTIVE (SUPPORTED)

Parameters

Responses

Example HTTP request

Request path

/v1/privatelink-endpoints/{privatelink_endpoint_id}/connection

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "api_id": "27bb070b564349f8a31cc60734cc36a5",
    "type": "CANCEL"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2024-05-17T00:23:17Z",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "status": "Active"
    }
}

1.1.3 - Create AccessControl

1.1.3.1 - 1.3

post /v1/apis/{api_id}/access-controls

Description

접근제어를 생성한다

상태 ACTIVE (CURRENT)

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/access-controls

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.3"

Request body

{
    "allowed_ip_addr": [
        "127.0.0.1/24,192.168.127.12"
    ],
    "connected_stages": [
        "dev,stg"
    ],
    "description": "description",
    "name": "DenyTest"
}

Example HTTP response

Response 201

{
    "allowed_ip_addr": [
        "127.0.0.1/24,192.168.127.12"
    ],
    "connected_stages": [
        "dev,stg"
    ],
    "created_at": "2024-05-19T00:23:17Z",
    "description": "",
    "id": "27bb070b564349f8a31cc60734cc36a5",
    "name": "DenyTest"
}

1.1.3.2 - 1.2

post /v1/apis/{api_id}/access-controls

Description

접근제어를 생성한다

상태 ACTIVE (SUPPORTED)

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/access-controls

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "allowed_ip_addr": [
        "127.0.0.1/24,192.168.127.12"
    ],
    "connected_stages": [
        "dev,stg"
    ],
    "description": "description",
    "name": "DenyTest"
}

Example HTTP response

Response 201

{
    "allowed_ip_addr": [
        "127.0.0.1/24,192.168.127.12"
    ],
    "connected_stages": [
        "dev,stg"
    ],
    "created_at": "2024-05-19T00:23:17Z",
    "description": "",
    "id": "27bb070b564349f8a31cc60734cc36a5",
    "name": "DenyTest"
}

1.1.3.3 - 1.1

post /v1/apis/{api_id}/access-controls

Description

접근제어를 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/access-controls

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "allowed_ip_addr": [
        "127.0.0.1/24,192.168.127.12"
    ],
    "connected_stages": [
        "dev,stg"
    ],
    "description": "description",
    "name": "DenyTest"
}

Example HTTP response

Response 201

{
    "allowed_ip_addr": [
        "127.0.0.1/24,192.168.127.12"
    ],
    "connected_stages": [
        "dev,stg"
    ],
    "created_at": "2024-05-19T00:23:17Z",
    "description": "",
    "id": "27bb070b564349f8a31cc60734cc36a5",
    "name": "DenyTest"
}

1.1.3.4 - 1.0

post /v1/apis/{api_id}/access-controls

Description

접근제어를 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/access-controls

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.0"

Request body

{
    "allowed_ip_addr": [
        "127.0.0.1/24,192.168.127.12"
    ],
    "connected_stages": [
        "dev,stg"
    ],
    "description": "description",
    "name": "DenyTest"
}

Example HTTP response

Response 201

{
    "allowed_ip_addr": [
        "127.0.0.1/24,192.168.127.12"
    ],
    "connected_stages": [
        "dev,stg"
    ],
    "created_at": "2024-05-19T00:23:17Z",
    "description": "",
    "id": "27bb070b564349f8a31cc60734cc36a5",
    "name": "DenyTest"
}

1.1.4 - Create Api

1.1.4.1 - 1.3

post /v1/apis

Description

API를 생성한다

상태 ACTIVE (CURRENT)

Parameters

Responses

Example HTTP request

Request path

/v1/apis

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.3"

Request body

{
    "description": "description",
    "endpoint_type": "REGION",
    "id": "",
    "name": "test-api",
    "tags": [
        {
            "key": "key",
            "value": "value"
        }
    ]
}

Example HTTP response

Response 202

{
    "description": "Description",
    "id": "27bb070b564349f8a31cc60734cc36a5",
    "name": "test-api"
}

1.1.4.2 - 1.2

post /v1/apis

Description

API를 생성한다

상태 ACTIVE (SUPPORTED)

Parameters

Responses

Example HTTP request

Request path

/v1/apis

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "description": "description",
    "endpoint_type": "REGION",
    "id": "",
    "name": "test-api",
    "tags": [
        {
            "key": "key",
            "value": "value"
        }
    ]
}

Example HTTP response

Response 202

{
    "description": "Description",
    "id": "27bb070b564349f8a31cc60734cc36a5",
    "name": "test-api"
}

1.1.4.3 - 1.1

post /v1/apis

Description

API를 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

Parameters

Responses

Example HTTP request

Request path

/v1/apis

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "description": "description",
    "id": "",
    "name": "test-api",
    "tags": [
        {
            "key": "key",
            "value": "value"
        }
    ]
}

Example HTTP response

Response 202

{
    "description": "Description",
    "id": "27bb070b564349f8a31cc60734cc36a5",
    "name": "test-api"
}

1.1.4.4 - 1.0

post /v1/apis

Description

API를 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

Parameters

Responses

Example HTTP request

Request path

/v1/apis

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.0"

Request body

{
    "description": "description",
    "id": "",
    "name": "test-api",
    "tags": [
        {
            "key": "key",
            "value": "value"
        }
    ]
}

Example HTTP response

Response 202

{
    "description": "Description",
    "id": "27bb070b564349f8a31cc60734cc36a5",
    "name": "test-api"
}

1.1.5 - Create Api Deployment

1.1.5.1 - 1.3

post /v1/apis/{api_id}/deployments

Description

API를 배포한다

상태 ACTIVE (CURRENT)

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/deployments

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.3"

Request body

{
    "description": "description",
    "stage_name": "test-stage",
    "stage_type": "new"
}

Example HTTP response

Response 200

{
    "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
    "description": "description"
}

1.1.5.2 - 1.2

post /v1/apis/{api_id}/deployments

Description

API를 배포한다

상태 ACTIVE (SUPPORTED)

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/deployments

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "description": "description",
    "stage_name": "test-stage",
    "stage_type": "new"
}

Example HTTP response

Response 200

{
    "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
    "description": "description"
}

1.1.5.3 - 1.1

post /v1/apis/{api_id}/deployments

Description

API를 배포한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/deployments

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "description": "description",
    "stage_name": "test-stage",
    "stage_type": "new"
}

Example HTTP response

Response 200

{
    "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
    "description": "description"
}

1.1.5.4 - 1.0

post /v1/apis/{api_id}/deployments

Description

API를 배포한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/deployments

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.0"

Request body

{
    "description": "description",
    "stage_name": "test-stage",
    "stage_type": "new"
}

Example HTTP response

Response 200

{
    "deployment_id": "27bb070b564349f8a31cc60734cc36a5",
    "description": "description"
}

1.1.6 - Create Api Key

1.1.6.1 - 1.3

post /v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys

Description

API Key를 생성한다

상태 ACTIVE (CURRENT)

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.3"

Request body

{
    "description": "description",
    "name": "api-key-name"
}

Example HTTP response

Response 200

{
    "api_key": {
        "created_at": "2024-01-15T10:30:00.000Z",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "key": "key",
        "name": "api-key-name"
    }
}

1.1.6.2 - 1.2

post /v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys

Description

API Key를 생성한다

상태 ACTIVE (SUPPORTED)

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "description": "description",
    "name": "api-key-name"
}

Example HTTP response

Response 200

{
    "api_key": {
        "created_at": "2024-01-15T10:30:00.000Z",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "key": "key",
        "name": "api-key-name"
    }
}

1.1.6.3 - 1.1

post /v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys

Description

API Key를 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/usage-plans/{usage_plan_id}/api-keys

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "description": "description",
    "name": "api-key-name"
}

Example HTTP response

Response 200

{
    "api_key": {
        "created_at": "2024-01-15T10:30:00.000Z",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "key": "key",
        "name": "api-key-name"
    }
}

1.1.7 - Create Auth

1.1.7.1 - 1.3

post /v1/apis/{api_id}/auths

Description

인증을 생성한다

상태 ACTIVE (CURRENT)

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/auths

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.3"

Request body

{
    "connected_stages": [
        "dev,stg"
    ],
    "expiration_period": "90",
    "name": "Token01"
}

Example HTTP response

Response 201

{
    "access_token": "***********************************************************"
}

1.1.7.2 - 1.2

post /v1/apis/{api_id}/auths

Description

인증을 생성한다

상태 ACTIVE (SUPPORTED)

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/auths

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "connected_stages": [
        "dev,stg"
    ],
    "expiration_period": "90",
    "name": "Token01"
}

Example HTTP response

Response 201

{
    "access_token": "***********************************************************"
}

1.1.7.3 - 1.1

post /v1/apis/{api_id}/auths

Description

인증을 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/auths

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "connected_stages": [
        "dev,stg"
    ],
    "expiration_period": "90",
    "name": "Token01"
}

Example HTTP response

Response 201

{
    "access_token": "***********************************************************"
}

1.1.7.4 - 1.0

post /v1/apis/{api_id}/auths

Description

인증을 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/auths

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.0"

Request body

{
    "connected_stages": [
        "dev,stg"
    ],
    "expiration_period": "90",
    "name": "Token01"
}

Example HTTP response

Response 201

{
    "access_token": "***********************************************************"
}

1.1.8 - Create Method

1.1.8.1 - 1.3

post /v1/apis/{api_id}/resources/{resource_id}/methods

Description

메서드를 생성한다

상태 ACTIVE (CURRENT)

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}/methods

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.3"

Request body

{
    "api_key_required": false,
    "endpoint_url": "https://127.0.0.1:8000",
    "function_id": "27bb070b564349f8a31cc60734cc36a5",
    "iam_enabled": false,
    "integration_type": "HTTP",
    "method_type": "GET",
    "privatelink_endpoint_id": "27bb070b564349f8a31cc60734cc36a5",
    "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
    "request_headers": "{'test1' : True}"
}

Example HTTP response

Response 200

{
    "methods": [
        {
            "api_key_required": false,
            "endpoint_url": "https://127.0.0.1:8000",
            "function_id": "27bb070b564349f8a31cc60734cc36a5",
            "function_name": "test-function",
            "iam_enabled": false,
            "integration_type": "HTTP",
            "method_type": "GET",
            "privatelink_endpoint_id": "27bb070b564349f8a31cc60734cc36a5",
            "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
            "request_headers": "{'test1' : True}",
            "request_path": "{users}",
            "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
        }
    ]
}

1.1.8.2 - 1.2

post /v1/apis/{api_id}/resources/{resource_id}/methods

Description

메서드를 생성한다

상태 ACTIVE (SUPPORTED)

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}/methods

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "api_key_required": false,
    "endpoint_url": "https://127.0.0.1:8000",
    "function_id": "27bb070b564349f8a31cc60734cc36a5",
    "iam_enabled": false,
    "integration_type": "HTTP",
    "method_type": "GET",
    "privatelink_endpoint_id": "27bb070b564349f8a31cc60734cc36a5",
    "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
    "request_headers": "{'test1' : True}"
}

Example HTTP response

Response 200

{
    "methods": [
        {
            "api_key_required": false,
            "endpoint_url": "https://127.0.0.1:8000",
            "function_id": "27bb070b564349f8a31cc60734cc36a5",
            "function_name": "test-function",
            "integration_type": "HTTP",
            "method_type": "GET",
            "privatelink_endpoint_id": "27bb070b564349f8a31cc60734cc36a5",
            "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
            "request_headers": "{'test1' : True}",
            "request_path": "{users}",
            "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
        }
    ]
}

1.1.8.3 - 1.1

post /v1/apis/{api_id}/resources/{resource_id}/methods

Description

메서드를 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}/methods

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "api_key_required": false,
    "endpoint_url": "https://127.0.0.1:8000",
    "function_id": "27bb070b564349f8a31cc60734cc36a5",
    "iam_enabled": false,
    "integration_type": "HTTP",
    "method_type": "GET",
    "privatelink_endpoint_id": "27bb070b564349f8a31cc60734cc36a5",
    "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
    "request_headers": "{'test1' : True}"
}

Example HTTP response

Response 200

{
    "methods": [
        {
            "api_key_required": false,
            "endpoint_url": "https://127.0.0.1:8000",
            "function_id": "27bb070b564349f8a31cc60734cc36a5",
            "function_name": "test-function",
            "integration_type": "HTTP",
            "method_type": "GET",
            "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
            "request_headers": "{'test1' : True}",
            "request_path": "{users}",
            "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
        }
    ]
}

1.1.8.4 - 1.0

post /v1/apis/{api_id}/resources/{resource_id}/methods

Description

메서드를 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{resource_id}/methods

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.0"

Request body

{
    "api_key_required": false,
    "endpoint_url": "https://127.0.0.1:8000",
    "function_id": "27bb070b564349f8a31cc60734cc36a5",
    "iam_enabled": false,
    "integration_type": "HTTP",
    "method_type": "GET",
    "privatelink_endpoint_id": "27bb070b564349f8a31cc60734cc36a5",
    "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
    "request_headers": "{'test1' : True}"
}

Example HTTP response

Response 200

{
    "methods": [
        {
            "endpoint_url": "https://127.0.0.1:8000",
            "function_id": "27bb070b564349f8a31cc60734cc36a5",
            "integration_type": "HTTP",
            "method_type": "GET",
            "query_strings": "{'param1': 'value1', 'param2': 'value2'}",
            "request_headers": "{'test1' : True}",
            "request_path": "{users}",
            "srn": "srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test"
        }
    ]
}

1.1.9 - Create PrivateLink Endpoint

1.1.9.1 - 1.3

post /v1/privatelink-endpoints

Description

PrivateLink 엔드포인트를 생성한다

상태 ACTIVE (CURRENT)

Parameters

Responses

Example HTTP request

Request path

/v1/privatelink-endpoints

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.3"

Request body

{
    "description": "description",
    "name": "endpoint",
    "privatelink_service_id": "27bb070b564349f8a31cc60734cc36a5"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2024-05-17T00:23:17Z",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "endpoint",
        "privatelink_service_id": "27bb070b564349f8a31cc60734cc36a5",
        "status": "CANCELED"
    }
}

1.1.9.2 - 1.2

post /v1/privatelink-endpoints

Description

PrivateLink 엔드포인트를 생성한다

상태 ACTIVE (SUPPORTED)

Parameters

Responses

Example HTTP request

Request path

/v1/privatelink-endpoints

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "description": "description",
    "name": "endpoint",
    "privatelink_service_id": "27bb070b564349f8a31cc60734cc36a5"
}

Example HTTP response

Response 200

{
    "privatelink_endpoint": {
        "created_at": "2024-05-17T00:23:17Z",
        "description": "description",
        "id": "27bb070b564349f8a31cc60734cc36a5",
        "name": "endpoint",
        "privatelink_service_id": "27bb070b564349f8a31cc60734cc36a5",
        "status": "CANCELED"
    }
}

1.1.10 - Create Resource

1.1.10.1 - 1.3

post /v1/apis/{api_id}/resources/{parent_id}

Description

리소스를 생성한다

상태 ACTIVE (CURRENT)

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{parent_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.3"

Request body

{
    "path_part": "test"
}

Example HTTP response

Response 200

{
    "api_id": "27bb070b564349f8a31cc60734cc36a5",
    "id": "27bb070b564349f8a31cc60734cc36a5",
    "parent_id": "27bb070b564349f8a31cc60734cc36a5",
    "path": ""
}

1.1.10.2 - 1.2

post /v1/apis/{api_id}/resources/{parent_id}

Description

리소스를 생성한다

상태 ACTIVE (SUPPORTED)

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{parent_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.2"

Request body

{
    "path_part": "test"
}

Example HTTP response

Response 200

{
    "api_id": "27bb070b564349f8a31cc60734cc36a5",
    "id": "27bb070b564349f8a31cc60734cc36a5",
    "parent_id": "27bb070b564349f8a31cc60734cc36a5",
    "path": ""
}

1.1.10.3 - 1.1

post /v1/apis/{api_id}/resources/{parent_id}

Description

리소스를 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{parent_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.1"

Request body

{
    "path_part": "test"
}

Example HTTP response

Response 200

{
    "api_id": "27bb070b564349f8a31cc60734cc36a5",
    "id": "27bb070b564349f8a31cc60734cc36a5",
    "parent_id": "27bb070b564349f8a31cc60734cc36a5",
    "path": ""
}

1.1.10.4 - 1.0

post /v1/apis/{api_id}/resources/{parent_id}

Description

리소스를 생성한다

상태 ACTIVE (DEPRECATED)

Not Before 기간이 도래하거나 만료된 Deprecated 버전은 더 이상 지원하지 않습니다. 최신 버전 사용을 권장합니다.

Parameters

Responses

Example HTTP request

Request path

/v1/apis/{api_id}/resources/{parent_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = ko-KR",
"Scp-Api-Version = apigateway 1.0"

Request body

{
    "path_part": "test"
}

Example HTTP response

Response 200

{
    "api_id": "27bb070b564349f8a31cc60734cc36a5",
    "id": "27bb070b564349f8a31cc60734cc36a5",
    "parent_id": "27bb070b564349f8a31cc60734cc36a5",
    "path": ""
}

1.1.11 - Create Stage

1.1.11.1 - 1.3

post /v1/apis/{api_id}/stages

Description

스테이지를 생성한다

상태 ACTIVE (CURRENT)