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가 추가되었습니다.