API Gateway

Overview

SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.

본 가이드는 API Gateway 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.

Version

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

CLI Version History

1.3

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

변경사항

• [신규] application-apigateway resource policy show --api_id <value> - Show Resource Policy 명령어가 추가되었습니다.
• [신규] application-apigateway resource policy set --api_id <value> --version <value> --statement <value> - Set Resource Policy 명령어가 추가되었습니다.
• [신규] application-apigateway resource policy delete --api_id <value> - Delete Resource Policy 명령어가 추가되었습니다.
• [변경] application-apigateway resource list --api_id <value> - 응답 시, 아래와 같은 필드가 추가됩니다.
  • iam_enabled
• [변경] application-apigateway resource show --resource_id <value> --api_id <value> - 응답 시, 아래와 같은 필드가 추가됩니다.
  • iam_enabled
• [변경] application-apigateway method list --resource_id <value> --api_id <value> - 응답 시, 아래와 같은 필드가 추가됩니다.
  • iam_enabled
• [변경] application-apigateway method create --resource_id <value> --api_id <value> --method_type <value> --integration_type <value> - 요청 시, 아래와 같은 필드가 추가됩니다.
  • iam_enabled
• [변경] application-apigateway method set --method_type <value> --resource_id <value> --api_id <value> --request_headers <value> --query_strings <value> --integration_type <value> --iam_enabled <value> --api_key_required <value> - 요청 시, 아래와 같은 필드가 추가됩니다.
  • iam_enabled
• [변경] application-apigateway method show --method_type <value> --resource_id <value> --api_id <value> - 응답 시, 아래와 같은 필드가 추가됩니다.
  • iam_enabled
• [변경] application-apigateway stage list --api_id <value> - 응답 시, 아래와 같은 필드가 추가됩니다.
  • description
  • api_key_required
  • usage_plan_name
  • uesage_plan_id
  • usage_plan_rate
  • usage_plan_limit
  • usage_plan_api_keys
• [변경] application-apigateway stage list --api_id <value> - 응답 시, 아래와 같은 필드가 삭제됩니다.
  • api_key_required
• [변경] application-apigateway stage list --api_id <value> - 응답 시, methods 필드의 형태가 아래처럼 변경됩니다.
  • 기존 "methods": [{"type": GET", "api_key_required": true}]
  • 변경 "methods": [{"type": GET", "api_key_required": true, "iam_enabled": true}]
• [변경] application-apigateway stage show --api_id <value> --stage_name <value> - 응답 시, 아래와 같은 필드가 삭제됩니다.
  • api_key_required

1.2

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

변경사항

• [신규] application-apigateway api connected endpoint list --api_id <value> - List Connected PrivateLink Endpoints 명령어가 추가되었습니다.
• [신규] application-apigateway privatelink endpoint list - List PrivateLink Endpoints 명령어가 추가되었습니다.
• [신규] application-apigateway privatelink endpoint create --privatelink_service_id <value> --name <value> - Create PrivateLink Endpoint 명령어가 추가되었습니다.
• [신규] application-apigateway privatelink endpoint delete --privatelink_endpoint_id <value> - Delete PrivateLink Endpoint 명령어가 추가되었습니다.
• [신규] application-apigateway privatelink endpoint set --privatelink_endpoint_id <value> - Set PrivateLink Endpoint 명령어가 추가되었습니다.
• [신규] application-apigateway privatelink endpoint approve --privatelink_endpoint_id <value> --type <value> --api_id <value> - Approve PrivateLink Endpoint 명령어가 추가되었습니다.
• [신규] application-apigateway privatelink endpoint connect --privatelink_endpoint_id <value> --type <value> --api_id <value> - Connect PrivateLink Endpoint 명령어가 추가되었습니다.
• [신규] application-apigateway privatelink endpoint request --privatelink_endpoint_id <value> --type <value> - Request PrivateLink Endpoint 명령어가 추가되었습니다.
• [신규] application-apigateway privatelink endpoint show --privatelink_endpoint_id <value> - Show PrivateLink Endpoint 명령어가 추가되었습니다.
• [변경] application-apigateway api list - 응답 시, 아래와 같은 필드가 추가됩니다.
  • endpoint_type
• [변경] application-apigateway api create --name <value> - 요청 시, 아래와 같은 필드가 추가됩니다.
  • endpoint_type
• [변경] application-apigateway api show --api_id <value> - 응답 시, 아래와 같은 필드가 추가됩니다.
  • endpoint_type
  • privatelink_service_id
• [변경] application-apigateway resource list --api_id <value> - 응답 시, 아래와 같은 필드가 추가됩니다.
  • privatelink_endpoint_id
• [변경] application-apigateway resource show --resource_id <value> --api_id <value> - 응답 시, 아래와 같은 필드가 추가됩니다.
  • privatelink_endpoint_id
• [변경] application-apigateway method list --resource_id <value> --api_id <value> - 응답 시, 아래와 같은 필드가 추가됩니다.
  • privatelink_endpoint_id
• [변경] application-apigateway method create --resource_id <value> --api_id <value> --method_type <value> --integration_type <value> - 요청 시, 아래와 같은 필드가 추가됩니다.
  • privatelink_endpoint_id
• [변경] application-apigateway method set --method_type <value> --resource_id <value> --api_id <value> --request_headers <value> --query_strings <value> --integration_type <value> --iam_enabled <value> --api_key_required <value> - 요청 시, 아래와 같은 필드가 추가됩니다.
  • privatelink_endpoint_id
• [변경] application-apigateway method show --method_type <value> --resource_id <value> --api_id <value> - 응답 시, 아래와 같은 필드가 추가됩니다.
  • privatelink_endpoint_id

1.1

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

변경사항

• [신규] application-apigateway usage plan list --api_id <value> - List Usage Plans 명령어가 추가되었습니다.
• [신규] application-apigateway usage plan create --api_id <value> --rate <value> --name <value> --limit <value> - Create Usage Plan 명령어가 추가되었습니다.
• [신규] application-apigateway usage plan set description --usage_plan_id <value> --api_id <value> - Set Usage Plan Description 명령어가 추가되었습니다.
• [신규] application-apigateway usage plan set quota --usage_plan_id <value> --api_id <value> --rate <value> --limit <value> - Set Usage Plan Quota 명령어가 추가되었습니다.
• [신규] application-apigateway usage plan delete --usage_plan_id <value> --api_id <value> - Delete Usage Plan 명령어가 추가되었습니다.
• [신규] application-apigateway usage plan show --usage_plan_id <value> --api_id <value> - Show Usage Plan 명령어가 추가되었습니다.
• [신규] application-apigateway api key list --usage_plan_id <value> --api_id <value> - List Api Keys 명령어가 추가되었습니다.
• [신규] application-apigateway api key create --usage_plan_id <value> --api_id <value> --name <value> - Create APi Key 명령어가 추가되었습니다.
• [신규] application-apigateway api key set --api_key_id <value> --usage_plan_id <value> --api_id <value> - Set Api Key Description 명령어가 추가되었습니다.
• [신규] application-apigateway api key delete --api_key_id <value> --usage_plan_id <value> --api_id <value> - Delete Api Key 명령어가 추가되었습니다.
• [신규] application-apigateway report list --api_id <value> --end_date <value> --start_date <value> --stage_name <value> - List Reports 명령어가 추가되었습니다.
• [변경] application-apigateway resource list --api_id <value> - 응답 시, 아래와 같은 필드가 추가됩니다.
  • function_name
  • api_key_required
• [변경] application-apigateway resource show --resource_id <value> --api_id <value> - 응답 시, 아래와 같은 필드가 추가됩니다.
  • function_name
  • api_key_required
• [변경] application-apigateway method list --resource_id <value> --api_id <value> - 응답 시, 아래와 같은 필드가 추가됩니다.
  • function_name
  • api_key_required
• [변경] application-apigateway method create --resource_id <value> --api_id <value> --method_type <value> --integration_type <value> - 요청 시, 아래와 같은 필드가 추가됩니다.
  • api_key_required
• [변경] application-apigateway method set --method_type <value> --resource_id <value> --api_id <value> --request_headers <value> --query_strings <value> --integration_type <value> --iam_enabled <value> --api_key_required <value> - 요청 시, 아래와 같은 필드가 추가됩니다.
  • api_key_required
  • endpoint_url
  • function_id
  • integration_type
• [변경] application-apigateway method show --method_type <value> --resource_id <value> --api_id <value> - 응답 시, 아래와 같은 필드가 추가됩니다.
  • function_name
  • api_key_required
• [변경] application-apigateway stage list --api_id <value> - 응답 시, 아래와 같은 필드가 추가됩니다.
  • description
  • api_key_required
  • usage_plan_name
  • uesage_plan_id
  • usage_plan_rate
  • usage_plan_limit
  • usage_plan_api_keys
• [변경] application-apigateway stage list --api_id <value> - 응답 시, 아래와 같은 필드가 삭제됩니다.
  • ip_restriction_enabled
• [변경] application-apigateway stage list --api_id <value> - 응답 시, methods 필드의 형태가 아래처럼 변경됩니다.
  • 기존 "methods": ["GET", "POST"]
  • 변경 "methods": [{"type": GET", "api_key_required": true}]
• [변경] application-apigateway stage set configuration --api_id <value> --stage_name <value> --jwt_enabled <value> --cors_enabled <value> - 요청 시, 아래와 같은 필드가 추가됩니다.
  • description
  • usage_plan_id
  • connected_api_keys
• [변경] application-apigateway stage set configuration --api_id <value> --stage_name <value> --jwt_enabled <value> --cors_enabled <value> - 요청 시, 아래와 같은 필드가 삭제됩니다.
  • ip_restriction_enabled
• [변경] application-apigateway stage show --api_id <value> --stage_name <value> - 응답 시, 아래와 같은 필드가 추가됩니다.
  • description
  • api_key_required
  • usage_plan_name
  • uesage_plan_id
  • usage_plan_rate
  • usage_plan_limit
  • usage_plan_api_keys
• [변경] application-apigateway stage show --api_id <value> --stage_name <value> - 응답 시, 아래와 같은 필드가 삭제됩니다.
  • ip_restriction_enabled

1.0

API Gateway CLI 출시되었습니다.

변경사항

• [신규] application-apigateway api list - List APis 명령어가 추가되었습니다.
• [신규] application-apigateway api create --name <value> - Create Api 명령어가 추가되었습니다.
• [신규] application-apigateway api description set --api_id <value> - Set Api Description 명령어가 추가되었습니다.
• [신규] application-apigateway api delete --api_id <value> - Delete Api 명령어가 추가되었습니다.
• [신규] application-apigateway api show --api_id <value> - Show Api 명령어가 추가되었습니다.
• [신규] application-apigateway api deployment list --api_id <value> - List Api Deployments 명령어가 추가되었습니다.
• [신규] application-apigateway api deploy --api_id <value> --stage_type <value> - Create Api Deployment 명령어가 추가되었습니다.
• [신규] application-apigateway resource list --api_id <value> - List Resources 명령어가 추가되었습니다.
• [신규] application-apigateway resource create --parent_id <value> --api_id <value> --path_part <value> - Create Resource 명령어가 추가되었습니다.
• [신규] application-apigateway resource delete --resource_id <value> --api_id <value> - Delete Resource 명령어가 추가되었습니다.
• [신규] application-apigateway resource show --resource_id <value> --api_id <value> - Show Resource 명령어가 추가되었습니다.
• [신규] application-apigateway method list --resource_id <value> --api_id <value> - List Methods 명령어가 추가되었습니다.
• [신규] application-apigateway method create --resource_id <value> --api_id <value> --method_type <value> --integration_type <value> - Create Method 명령어가 추가되었습니다.
• [신규] application-apigateway method set --method_type <value> --resource_id <value> --api_id <value> --request_headers <value> --query_strings <value> --integration_type <value> --iam_enabled <value> --api_key_required <value> - Set Method 명령어가 추가되었습니다.
• [신규] application-apigateway method delete --method_type <value> --resource_id <value> --api_id <value> - Delete Method 명령어가 추가되었습니다.
• [신규] application-apigateway method show --method_type <value> --resource_id <value> --api_id <value> - Show Method 명령어가 추가되었습니다.
• [신규] application-apigateway stage list --api_id <value> - List Stages 명령어가 추가되었습니다.
• [신규] application-apigateway stage create --api_id <value> --stage_name <value> --deployment_id <value> - Create Stage 명령어가 추가되었습니다.
• [신규] application-apigateway stage delete --api_id <value> --stage_name <value> - Delete Stage 명령어가 추가되었습니다.
• [신규] application-apigateway stage show --api_id <value> --stage_name <value> - Show Stage 명령어가 추가되었습니다.
• [신규] application-apigateway stage set active deployment --api_id <value> --stage_name <value> --deployment_id <value> - Set Stage Active Deployment 명령어가 추가되었습니다.
• [신규] application-apigateway stage set configuration --api_id <value> --stage_name <value> --jwt_enabled <value> --cors_enabled <value> - Set Stage Configuration 명령어가 추가되었습니다.
• [신규] application-apigateway auth list --api_id <value> - List Auths 명령어가 추가되었습니다.
• [신규] application-apigateway auth create --api_id <value> --name <value> --expiration_period <value> --connected_stages <value> - Create Auth 명령어가 추가되었습니다.
• [신규] application-apigateway auth set --auth_id <value> --api_id <value> --connected_stages <value> - Set Auth 명령어가 추가되었습니다.
• [신규] application-apigateway auth delete --auth_id <value> --api_id <value> - Delete Auth 명령어가 추가되었습니다.
• [신규] application-apigateway auth show --auth_id <value> --api_id <value> - Show Auth 명령어가 추가되었습니다.
• [신규] application-apigateway access control list --api_id <value> - List AccessControls 명령어가 추가되었습니다.
• [신규] application-apigateway access control create --api_id <value> --name <value> --connected_stages <value> --allowed_ip_addr <value> - Create AccessControl 명령어가 추가되었습니다.
• [신규] application-apigateway access control set --access_control_id <value> --api_id <value> --connected_stages <value> --allowed_ip_addr <value> - Set AccessControl 명령어가 추가되었습니다.
• [신규] application-apigateway access control delete --access_control_id <value> --api_id <value> - Delete AccessControl 명령어가 추가되었습니다.
• [신규] application-apigateway access control show --access_control_id <value> --api_id <value> - Show AccessControl 명령어가 추가되었습니다.