API Gateway

Overview

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

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

Version

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

VersionStatusNot Before
1.3CURRENT-
1.2SUPPORTED20260630
1.1DEPRECATED20260430
1.0DEPRECATED20251231

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

1 - CLIs

1.1 - Approve PrivateLink Endpoint

1.1.1 - 1.3

scp-cli application-apigateway privatelink endpoint approve
--privatelink_endpoint_id <value>
--type <value>
--api_id <value>

Description

PrivateLink 엔드포인트를 승인한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
type
required
stringPrivateLink 엔드포인트 액션 유형CANCEL
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.1.2 - 1.2

scp-cli application-apigateway privatelink endpoint approve
--privatelink_endpoint_id <value>
--type <value>
--api_id <value>

Description

PrivateLink 엔드포인트를 승인한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
type
required
stringPrivateLink 엔드포인트 액션 유형CANCEL
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.2 - Connect PrivateLink Endpoint

1.2.1 - 1.3

scp-cli application-apigateway privatelink endpoint connect
--privatelink_endpoint_id <value>
--type <value>
--api_id <value>

Description

PrivateLink 엔드포인트를 연결한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
type
required
stringPrivateLink 엔드포인트 액션 유형CANCEL
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.2.2 - 1.2

scp-cli application-apigateway privatelink endpoint connect
--privatelink_endpoint_id <value>
--type <value>
--api_id <value>

Description

PrivateLink 엔드포인트를 연결한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
type
required
stringPrivateLink 엔드포인트 액션 유형CANCEL
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.3 - Create AccessControl

1.3.1 - 1.3

scp-cli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

접근제어를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
string접근제어명DenyTest
connected_stages
required
array연결된 스테이지dev,stg
allowed_ip_addr
required
array허용 IP 주소127.0.0.1/24,192.168.127.12
description
optional
string설명description

Responses

NameDescriptionExample
id접근제어 ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr허용 IP 주소[‘127.0.0.1/24,192.168.127.12’]
connected_stages연결된 스테이지[‘dev,stg’]
created_at생성 일시2024-05-19T00:23:17Z
description설명
name접근제어명DenyTest

1.3.2 - 1.2

scp-cli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

접근제어를 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
string접근제어명DenyTest
connected_stages
required
array연결된 스테이지dev,stg
allowed_ip_addr
required
array허용 IP 주소127.0.0.1/24,192.168.127.12
description
optional
string설명description

Responses

NameDescriptionExample
id접근제어 ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr허용 IP 주소[‘127.0.0.1/24,192.168.127.12’]
connected_stages연결된 스테이지[‘dev,stg’]
created_at생성 일시2024-05-19T00:23:17Z
description설명
name접근제어명DenyTest

1.3.3 - 1.1

scp-cli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

접근제어를 생성한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
string접근제어명DenyTest
connected_stages
required
array연결된 스테이지dev,stg
allowed_ip_addr
required
array허용 IP 주소127.0.0.1/24,192.168.127.12
description
optional
string설명description

Responses

NameDescriptionExample
id접근제어 ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr허용 IP 주소[‘127.0.0.1/24,192.168.127.12’]
connected_stages연결된 스테이지[‘dev,stg’]
created_at생성 일시2024-05-19T00:23:17Z
description설명
name접근제어명DenyTest

1.3.4 - 1.0

scp-cli application-apigateway access control create
--api_id <value>
--name <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

접근제어를 생성한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
string접근제어명DenyTest
connected_stages
required
array연결된 스테이지dev,stg
allowed_ip_addr
required
array허용 IP 주소127.0.0.1/24,192.168.127.12
description
optional
string설명description

Responses

NameDescriptionExample
id접근제어 ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr허용 IP 주소[‘127.0.0.1/24,192.168.127.12’]
connected_stages연결된 스테이지[‘dev,stg’]
created_at생성 일시2024-05-19T00:23:17Z
description설명
name접근제어명DenyTest

1.4 - Create Api

1.4.1 - 1.3

scp-cli application-apigateway api create
--name <value>
[--description <value>]
[--endpoint_type <value>]
[--id <value>]
[--tags <value>]

Description

API를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
name
required
string이름test-api
description
optional
string설명description
endpoint_type
optional
string엔드포인트 유형-
id
optional
stringApi ID-
tags
optional
array태그 목록'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
description설명Description
name이름test-api

1.4.2 - 1.2

scp-cli application-apigateway api create
--name <value>
[--description <value>]
[--endpoint_type <value>]
[--id <value>]
[--tags <value>]

Description

API를 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
name
required
string이름test-api
description
optional
string설명description
endpoint_type
optional
string엔드포인트 유형-
id
optional
stringApi ID-
tags
optional
array태그 목록'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
description설명Description
name이름test-api

1.4.3 - 1.1

scp-cli application-apigateway api create
--name <value>
[--description <value>]
[--id <value>]
[--tags <value>]

Description

API를 생성한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
name
required
string이름test-api
description
optional
string설명description
id
optional
stringApi ID-
tags
optional
array태그 목록'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
description설명Description
name이름test-api

1.4.4 - 1.0

scp-cli application-apigateway api create
--name <value>
[--description <value>]
[--id <value>]
[--tags <value>]

Description

API를 생성한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
name
required
string이름test-api
description
optional
string설명description
id
optional
stringApi ID-
tags
optional
array태그 목록'{"key": "key", "value": "value"}'

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
description설명Description
name이름test-api

1.5 - Create Api Deployment

1.5.1 - 1.3

scp-cli application-apigateway api deploy
--api_id <value>
--stage_type <value>
[--description <value>]
[--stage_name <value>]

Description

API를 배포한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
stage_type
required
string스테이지 유형new
description
optional
string설명description
stage_name
optional
string스테이지명test-stage

Responses

NameDescriptionExample
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description

1.5.2 - 1.2

scp-cli application-apigateway api deploy
--api_id <value>
--stage_type <value>
[--description <value>]
[--stage_name <value>]

Description

API를 배포한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
stage_type
required
string스테이지 유형new
description
optional
string설명description
stage_name
optional
string스테이지명test-stage

Responses

NameDescriptionExample
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description

1.5.3 - 1.1

scp-cli application-apigateway api deploy
--api_id <value>
--stage_type <value>
[--description <value>]
[--stage_name <value>]

Description

API를 배포한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
stage_type
required
string스테이지 유형new
description
optional
string설명description
stage_name
optional
string스테이지명test-stage

Responses

NameDescriptionExample
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description

1.5.4 - 1.0

scp-cli application-apigateway api deploy
--api_id <value>
--stage_type <value>
[--description <value>]
[--stage_name <value>]

Description

API를 배포한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
stage_type
required
string스테이지 유형new
description
optional
string설명description
stage_name
optional
string스테이지명test-stage

Responses

NameDescriptionExample
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description

1.6 - Create Api Key

1.6.1 - 1.3

scp-cli application-apigateway api key create
--usage_plan_id <value>
--api_id <value>
--name <value>
[--description <value>]

Description

API Key를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
name
required
string이름api-key-name
description
optional
string설명description

Responses

NameDescriptionExample
idAPI Key ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시
description설명description
keyKeykey
name이름api-key-name

1.6.2 - 1.2

scp-cli application-apigateway api key create
--usage_plan_id <value>
--api_id <value>
--name <value>
[--description <value>]

Description

API Key를 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
name
required
string이름api-key-name
description
optional
string설명description

Responses

NameDescriptionExample
idAPI Key ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시
description설명description
keyKeykey
name이름api-key-name

1.6.3 - 1.1

scp-cli application-apigateway api key create
--usage_plan_id <value>
--api_id <value>
--name <value>
[--description <value>]

Description

API Key를 생성한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
name
required
string이름api-key-name
description
optional
string설명description

Responses

NameDescriptionExample
idAPI Key ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시
description설명description
keyKeykey
name이름api-key-name

1.7 - Create Auth

1.7.1 - 1.3

scp-cli application-apigateway auth create
--api_id <value>
--name <value>
--expiration_period <value>
--connected_stages <value>

Description

인증을 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
string인증명Token01
expiration_period
required
integer만료 기간90
connected_stages
required
array연결된 스테이지dev,stg

Responses

NameDescriptionExample
access_token액세스 토큰***********************************************************

1.7.2 - 1.2

scp-cli application-apigateway auth create
--api_id <value>
--name <value>
--expiration_period <value>
--connected_stages <value>

Description

인증을 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
string인증명Token01
expiration_period
required
integer만료 기간90
connected_stages
required
array연결된 스테이지dev,stg

Responses

NameDescriptionExample
access_token액세스 토큰***********************************************************

1.7.3 - 1.1

scp-cli application-apigateway auth create
--api_id <value>
--name <value>
--expiration_period <value>
--connected_stages <value>

Description

인증을 생성한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
string인증명Token01
expiration_period
required
integer만료 기간90
connected_stages
required
array연결된 스테이지dev,stg

Responses

NameDescriptionExample
access_token액세스 토큰***********************************************************

1.7.4 - 1.0

scp-cli application-apigateway auth create
--api_id <value>
--name <value>
--expiration_period <value>
--connected_stages <value>

Description

인증을 생성한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
name
required
string인증명Token01
expiration_period
required
integer만료 기간90
connected_stages
required
array연결된 스테이지dev,stg

Responses

NameDescriptionExample
access_token액세스 토큰***********************************************************

1.8 - Create Method

1.8.1 - 1.3

scp-cli application-apigateway method create
--resource_id <value>
--api_id <value>
--method_type <value>
--integration_type <value>
[--api_key_required <value>]
[--endpoint_url <value>]
[--function_id <value>]
[--iam_enabled <value>]
[--privatelink_endpoint_id <value>]
[--query_strings <value>]
[--request_headers <value>]

Description

메서드를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
method_type
required
string메서드 유형GET
integration_type
required
string메서드 통합 유형HTTP
api_key_required
optional
booleanAPI Key 사용여부False
endpoint_url
optional
string메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
iam_enabled
optional
booleanIAM 정책 적용여부False
privatelink_endpoint_id
optional
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
query_strings
optional
object메서드 쿼리 문자열{'param1': 'value1', 'param2': 'value2'}
request_headers
optional
object메서드 요청 헤더{'test1' : True}

Responses

NameDescriptionExample
api_key_requiredAPI Key 사용여부False
endpoint_url메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
iam_enabledIAM 정책 적용여부False
integration_type메서드 통합 유형HTTP
method_type메서드 유형GET
privatelink_endpoint_idPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
query_strings메서드 쿼리 문자열{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers메서드 요청 헤더{’test1’ : True}
request_path메서드 요청 경로{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.8.2 - 1.2

scp-cli application-apigateway method create
--resource_id <value>
--api_id <value>
--method_type <value>
--integration_type <value>
[--api_key_required <value>]
[--endpoint_url <value>]
[--function_id <value>]
[--iam_enabled <value>]
[--privatelink_endpoint_id <value>]
[--query_strings <value>]
[--request_headers <value>]

Description

메서드를 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
method_type
required
string메서드 유형GET
integration_type
required
string메서드 통합 유형HTTP
api_key_required
optional
booleanAPI Key 사용여부False
endpoint_url
optional
string메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
iam_enabled
optional
booleanIAM 정책 적용여부False
privatelink_endpoint_id
optional
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
query_strings
optional
object메서드 쿼리 문자열{'param1': 'value1', 'param2': 'value2'}
request_headers
optional
object메서드 요청 헤더{'test1' : True}

Responses

NameDescriptionExample
api_key_requiredAPI Key 사용여부False
endpoint_url메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_type메서드 통합 유형HTTP
method_type메서드 유형GET
privatelink_endpoint_idPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
query_strings메서드 쿼리 문자열{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers메서드 요청 헤더{’test1’ : True}
request_path메서드 요청 경로{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.8.3 - 1.1

scp-cli application-apigateway method create
--resource_id <value>
--api_id <value>
--method_type <value>
--integration_type <value>
[--api_key_required <value>]
[--endpoint_url <value>]
[--function_id <value>]
[--iam_enabled <value>]
[--privatelink_endpoint_id <value>]
[--query_strings <value>]
[--request_headers <value>]

Description

메서드를 생성한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
method_type
required
string메서드 유형GET
integration_type
required
string메서드 통합 유형HTTP
api_key_required
optional
booleanAPI Key 사용여부False
endpoint_url
optional
string메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
iam_enabled
optional
booleanIAM 정책 적용여부False
privatelink_endpoint_id
optional
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
query_strings
optional
object메서드 쿼리 문자열{'param1': 'value1', 'param2': 'value2'}
request_headers
optional
object메서드 요청 헤더{'test1' : True}

Responses

NameDescriptionExample
api_key_requiredAPI Key 사용여부False
endpoint_url메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_type메서드 통합 유형HTTP
method_type메서드 유형GET
query_strings메서드 쿼리 문자열{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers메서드 요청 헤더{’test1’ : True}
request_path메서드 요청 경로{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.8.4 - 1.0

scp-cli application-apigateway method create
--resource_id <value>
--api_id <value>
--method_type <value>
--integration_type <value>
[--api_key_required <value>]
[--endpoint_url <value>]
[--function_id <value>]
[--iam_enabled <value>]
[--privatelink_endpoint_id <value>]
[--query_strings <value>]
[--request_headers <value>]

Description

메서드를 생성한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
method_type
required
string메서드 유형GET
integration_type
required
string메서드 통합 유형HTTP
api_key_required
optional
booleanAPI Key 사용여부False
endpoint_url
optional
string메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
iam_enabled
optional
booleanIAM 정책 적용여부False
privatelink_endpoint_id
optional
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
query_strings
optional
object메서드 쿼리 문자열{'param1': 'value1', 'param2': 'value2'}
request_headers
optional
object메서드 요청 헤더{'test1' : True}

Responses

NameDescriptionExample
endpoint_url메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
integration_type메서드 통합 유형HTTP
method_type메서드 유형GET
query_strings메서드 쿼리 문자열{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers메서드 요청 헤더{’test1’ : True}
request_path메서드 요청 경로{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.9 - Create PrivateLink Endpoint

1.9.1 - 1.3

scp-cli application-apigateway privatelink endpoint create
--privatelink_service_id <value>
--name <value>
[--description <value>]

Description

PrivateLink 엔드포인트를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink 서비스 ID27bb070b564349f8a31cc60734cc36a5
name
required
stringPrivateLink 엔드포인트명endpoint
description
optional
string설명description

Responses

NameDescriptionExample
idPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
description설명description
namePrivateLink 엔드포인트명endpoint
privatelink_service_idPrivateLink 서비스 ID27bb070b564349f8a31cc60734cc36a5
statusPrivateLink 엔드포인트 상태CANCELED

1.9.2 - 1.2

scp-cli application-apigateway privatelink endpoint create
--privatelink_service_id <value>
--name <value>
[--description <value>]

Description

PrivateLink 엔드포인트를 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
privatelink_service_id
required
stringPrivateLink 서비스 ID27bb070b564349f8a31cc60734cc36a5
name
required
stringPrivateLink 엔드포인트명endpoint
description
optional
string설명description

Responses

NameDescriptionExample
idPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
description설명description
namePrivateLink 엔드포인트명endpoint
privatelink_service_idPrivateLink 서비스 ID27bb070b564349f8a31cc60734cc36a5
statusPrivateLink 엔드포인트 상태CANCELED

1.10 - Create Resource

1.10.1 - 1.3

scp-cli application-apigateway resource create
--parent_id <value>
--api_id <value>
--path_part <value>

Description

리소스를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
parent_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
path_part
required
string경로명test

Responses

NameDescriptionExample
id리소스 ID27bb070b564349f8a31cc60734cc36a5
api_idApi ID27bb070b564349f8a31cc60734cc36a5
parent_id부모 리소스 ID27bb070b564349f8a31cc60734cc36a5
path경로

1.10.2 - 1.2

scp-cli application-apigateway resource create
--parent_id <value>
--api_id <value>
--path_part <value>

Description

리소스를 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
parent_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
path_part
required
string경로명test

Responses

NameDescriptionExample
id리소스 ID27bb070b564349f8a31cc60734cc36a5
api_idApi ID27bb070b564349f8a31cc60734cc36a5
parent_id부모 리소스 ID27bb070b564349f8a31cc60734cc36a5
path경로

1.10.3 - 1.1

scp-cli application-apigateway resource create
--parent_id <value>
--api_id <value>
--path_part <value>

Description

리소스를 생성한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
parent_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
path_part
required
string경로명test

Responses

NameDescriptionExample
id리소스 ID27bb070b564349f8a31cc60734cc36a5
api_idApi ID27bb070b564349f8a31cc60734cc36a5
parent_id부모 리소스 ID27bb070b564349f8a31cc60734cc36a5
path경로

1.10.4 - 1.0

scp-cli application-apigateway resource create
--parent_id <value>
--api_id <value>
--path_part <value>

Description

리소스를 생성한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
parent_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
path_part
required
string경로명test

Responses

NameDescriptionExample
id리소스 ID27bb070b564349f8a31cc60734cc36a5
api_idApi ID27bb070b564349f8a31cc60734cc36a5
parent_id부모 리소스 ID27bb070b564349f8a31cc60734cc36a5
path경로

1.11 - Create Stage

1.11.1 - 1.3

scp-cli application-apigateway stage create
--api_id <value>
--stage_name <value>
--deployment_id <value>
[--description <value>]

Description

스테이지를 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string이름test-stage
deployment_id
required
string배포 ID27bb070b564349f8a31cc60734cc36a5
description
optional
string설명description

Responses

NameDescriptionExample
active_deployment활성화 배포2024-05-17T00:23:17Z
allow_credentials허용 인증True
allow_headers허용 헤더[‘Content-Type’, ‘Authorization’]
allow_methods허용 메서드[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins허용 원본[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredAPI Key 사용여부False
cors_enabledCORS 사용여부False
created_at생성 일시
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
expose_headers노출 헤더[’test1’, ’test2’]
invoke_url호출 URLhttp://test.com/stg
jwt_enabledJWT 사용여부False
max_age최대 캐시 기간3600
name스테이지명test-stage
usage_plan_api_keysAPI Key[]
usage_plan_id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limit사용량 정책 할당량10
usage_plan_name이름usage-plan-name
usage_plan_rate사용량 정책 주기day

1.11.2 - 1.2

scp-cli application-apigateway stage create
--api_id <value>
--stage_name <value>
--deployment_id <value>
[--description <value>]

Description

스테이지를 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string이름test-stage
deployment_id
required
string배포 ID27bb070b564349f8a31cc60734cc36a5
description
optional
string설명description

Responses

NameDescriptionExample
active_deployment활성화 배포2024-05-17T00:23:17Z
allow_credentials허용 인증True
allow_headers허용 헤더[‘Content-Type’, ‘Authorization’]
allow_methods허용 메서드[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins허용 원본[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredAPI Key 사용여부False
cors_enabledCORS 사용여부False
created_at생성 일시
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
expose_headers노출 헤더[’test1’, ’test2’]
invoke_url호출 URLhttp://test.com/stg
jwt_enabledJWT 사용여부False
max_age최대 캐시 기간3600
name스테이지명test-stage
usage_plan_api_keysAPI Key[]
usage_plan_id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limit사용량 정책 할당량10
usage_plan_name이름usage-plan-name
usage_plan_rate사용량 정책 주기day

1.11.3 - 1.1

scp-cli application-apigateway stage create
--api_id <value>
--stage_name <value>
--deployment_id <value>
[--description <value>]

Description

스테이지를 생성한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string이름test-stage
deployment_id
required
string배포 ID27bb070b564349f8a31cc60734cc36a5
description
optional
string설명description

Responses

NameDescriptionExample
active_deployment활성화 배포2024-05-17T00:23:17Z
allow_credentials허용 인증True
allow_headers허용 헤더[‘Content-Type’, ‘Authorization’]
allow_methods허용 메서드[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins허용 원본[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredAPI Key 사용여부False
cors_enabledCORS 사용여부False
created_at생성 일시
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
expose_headers노출 헤더[’test1’, ’test2’]
invoke_url호출 URLhttp://test.com/stg
jwt_enabledJWT 사용여부False
max_age최대 캐시 기간3600
name스테이지명test-stage
usage_plan_api_keysAPI Key[]
usage_plan_id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limit사용량 정책 할당량10
usage_plan_name이름usage-plan-name
usage_plan_rate사용량 정책 주기day

1.11.4 - 1.0

scp-cli application-apigateway stage create
--api_id <value>
--stage_name <value>
--deployment_id <value>
[--description <value>]

Description

스테이지를 생성한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string이름test-stage
deployment_id
required
string배포 ID27bb070b564349f8a31cc60734cc36a5
description
optional
string설명description

Responses

NameDescriptionExample
active_deployment활성화 배포2024-05-17T00:23:17Z
allow_credentials허용 인증True
allow_headers허용 헤더[‘Content-Type’, ‘Authorization’]
allow_methods허용 메서드[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins허용 원본[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
cors_enabledCORS 사용여부False
created_at생성 일시
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
expose_headers노출 헤더[’test1’, ’test2’]
invoke_url호출 URLhttp://test.com/stg
ip_restriction_enabledIP 접근제어 사용여부False
jwt_enabledJWT 사용여부False
max_age최대 캐시 기간3600
name스테이지명test-stage

1.12 - Create Usage Plans

1.12.1 - 1.3

scp-cli application-apigateway usage plan create
--api_id <value>
--rate <value>
--name <value>
--limit <value>
[--description <value>]

Description

사용량 정책을 생성한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
rate
required
string사용량 정책 주기day
name
required
string이름usage-plan-name
limit
required
integer사용량 정책 할당량10
description
optional
string설명description

Responses

NameDescriptionExample
id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_keysAPI Key[]
created_at생성 일시
created_by_id생성자27bb070b564349f8a31cc60734cc36a5
created_by_name생성자username
description설명description
limit사용량 정책 할당량10
modified_at수정시간
modified_by_id수정자27bb070b564349f8a31cc60734cc36a5
modified_by_name수정자username
name이름usage-plan-name
rate사용량 정책 주기day

1.12.2 - 1.2

scp-cli application-apigateway usage plan create
--api_id <value>
--rate <value>
--name <value>
--limit <value>
[--description <value>]

Description

사용량 정책을 생성한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
rate
required
string사용량 정책 주기day
name
required
string이름usage-plan-name
limit
required
integer사용량 정책 할당량10
description
optional
string설명description

Responses

NameDescriptionExample
id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_keysAPI Key[]
created_at생성 일시
created_by_id생성자27bb070b564349f8a31cc60734cc36a5
created_by_name생성자username
description설명description
limit사용량 정책 할당량10
modified_at수정시간
modified_by_id수정자27bb070b564349f8a31cc60734cc36a5
modified_by_name수정자username
name이름usage-plan-name
rate사용량 정책 주기day

1.12.3 - 1.1

scp-cli application-apigateway usage plan create
--api_id <value>
--rate <value>
--name <value>
--limit <value>
[--description <value>]

Description

사용량 정책을 생성한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
rate
required
string사용량 정책 주기day
name
required
string이름usage-plan-name
limit
required
integer사용량 정책 할당량10
description
optional
string설명description

Responses

NameDescriptionExample
id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_keysAPI Key[]
created_at생성 일시
created_by_id생성자27bb070b564349f8a31cc60734cc36a5
created_by_name생성자username
description설명description
limit사용량 정책 할당량10
modified_at수정시간
modified_by_id수정자27bb070b564349f8a31cc60734cc36a5
modified_by_name수정자username
name이름usage-plan-name
rate사용량 정책 주기day

1.13 - Delete Access Control

1.13.1 - 1.3

scp-cli application-apigateway access control delete
--access_control_id <value>
--api_id <value>

Description

접근제어를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
access_control_id
required
string접근제어 ID-
api_id
required
stringApi ID-

1.13.2 - 1.2

scp-cli application-apigateway access control delete
--access_control_id <value>
--api_id <value>

Description

접근제어를 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
access_control_id
required
string접근제어 ID-
api_id
required
stringApi ID-

1.13.3 - 1.1

scp-cli application-apigateway access control delete
--access_control_id <value>
--api_id <value>

Description

접근제어를 삭제한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
access_control_id
required
string접근제어 ID-
api_id
required
stringApi ID-

1.13.4 - 1.0

scp-cli application-apigateway access control delete
--access_control_id <value>
--api_id <value>

Description

접근제어를 삭제한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
access_control_id
required
string접근제어 ID-
api_id
required
stringApi ID-

1.14 - Delete an API Key

1.14.1 - 1.3

scp-cli application-apigateway api key delete
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>

Description

API Key를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_key_id
required
stringAPI Key ID27bb070b564349f8a31cc60734cc36a5
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.14.2 - 1.2

scp-cli application-apigateway api key delete
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>

Description

API Key를 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_key_id
required
stringAPI Key ID27bb070b564349f8a31cc60734cc36a5
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.14.3 - 1.1

scp-cli application-apigateway api key delete
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>

Description

API Key를 삭제한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_key_id
required
stringAPI Key ID27bb070b564349f8a31cc60734cc36a5
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.15 - Delete Api

1.15.1 - 1.3

scp-cli application-apigateway api delete
--api_id <value>

Description

API를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

1.15.2 - 1.2

scp-cli application-apigateway api delete
--api_id <value>

Description

API를 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

1.15.3 - 1.1

scp-cli application-apigateway api delete
--api_id <value>

Description

API를 삭제한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

1.15.4 - 1.0

scp-cli application-apigateway api delete
--api_id <value>

Description

API를 삭제한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

1.16 - Delete Auth

1.16.1 - 1.3

scp-cli application-apigateway auth delete
--auth_id <value>
--api_id <value>

Description

인증을 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
auth_id
required
string인증 ID-
api_id
required
stringApi ID-

1.16.2 - 1.2

scp-cli application-apigateway auth delete
--auth_id <value>
--api_id <value>

Description

인증을 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
auth_id
required
string인증 ID-
api_id
required
stringApi ID-

1.16.3 - 1.1

scp-cli application-apigateway auth delete
--auth_id <value>
--api_id <value>

Description

인증을 삭제한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
auth_id
required
string인증 ID-
api_id
required
stringApi ID-

1.16.4 - 1.0

scp-cli application-apigateway auth delete
--auth_id <value>
--api_id <value>

Description

인증을 삭제한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
auth_id
required
string인증 ID-
api_id
required
stringApi ID-

1.17 - Delete Method

1.17.1 - 1.3

scp-cli application-apigateway method delete
--method_type <value>
--resource_id <value>
--api_id <value>

Description

메서드를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
method_type
required
****메서드 유형GET
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.17.2 - 1.2

scp-cli application-apigateway method delete
--method_type <value>
--resource_id <value>
--api_id <value>

Description

메서드를 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
method_type
required
****메서드 유형GET
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.17.3 - 1.1

scp-cli application-apigateway method delete
--method_type <value>
--resource_id <value>
--api_id <value>

Description

메서드를 삭제한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
method_type
required
****메서드 유형GET
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.17.4 - 1.0

scp-cli application-apigateway method delete
--method_type <value>
--resource_id <value>
--api_id <value>

Description

메서드를 삭제한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
method_type
required
****메서드 유형GET
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.18 - Delete PrivateLink Endpoint

1.18.1 - 1.3

scp-cli application-apigateway privatelink endpoint delete
--privatelink_endpoint_id <value>

Description

PrivateLink 엔드포인트를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5

1.18.2 - 1.2

scp-cli application-apigateway privatelink endpoint delete
--privatelink_endpoint_id <value>

Description

PrivateLink 엔드포인트를 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5

1.19 - Delete Resource

1.19.1 - 1.3

scp-cli application-apigateway resource delete
--resource_id <value>
--api_id <value>

Description

리소스를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.19.2 - 1.2

scp-cli application-apigateway resource delete
--resource_id <value>
--api_id <value>

Description

리소스를 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.19.3 - 1.1

scp-cli application-apigateway resource delete
--resource_id <value>
--api_id <value>

Description

리소스를 삭제한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.19.4 - 1.0

scp-cli application-apigateway resource delete
--resource_id <value>
--api_id <value>

Description

리소스를 삭제한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.20 - Delete Resource Policy

1.20.1 - 1.3

scp-cli application-apigateway resource policy delete
--api_id <value>

Description

리소스 정책을 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.21 - Delete Stage

1.21.1 - 1.3

scp-cli application-apigateway stage delete
--api_id <value>
--stage_name <value>

Description

스테이지를 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage

1.21.2 - 1.2

scp-cli application-apigateway stage delete
--api_id <value>
--stage_name <value>

Description

스테이지를 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage

1.21.3 - 1.1

scp-cli application-apigateway stage delete
--api_id <value>
--stage_name <value>

Description

스테이지를 삭제한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage

1.21.4 - 1.0

scp-cli application-apigateway stage delete
--api_id <value>
--stage_name <value>

Description

스테이지를 삭제한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage

1.22 - Delete Usage Plan

1.22.1 - 1.3

scp-cli application-apigateway usage plan delete
--usage_plan_id <value>
--api_id <value>

Description

사용량 정책을 삭제한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.22.2 - 1.2

scp-cli application-apigateway usage plan delete
--usage_plan_id <value>
--api_id <value>

Description

사용량 정책을 삭제한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.22.3 - 1.1

scp-cli application-apigateway usage plan delete
--usage_plan_id <value>
--api_id <value>

Description

사용량 정책을 삭제한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

1.23 - List AccessControls

1.23.1 - 1.3

scp-cli application-apigateway access control list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

접근제어 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
id접근제어 ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr허용 IP 주소[‘127.0.0.1/24,192.168.127.12’]
connected_stages연결된 스테이지[‘dev,stg’]
created_at생성 일시2024-05-19T00:23:17Z
description설명
name접근제어명DenyTest

1.23.2 - 1.2

scp-cli application-apigateway access control list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

접근제어 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
id접근제어 ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr허용 IP 주소[‘127.0.0.1/24,192.168.127.12’]
connected_stages연결된 스테이지[‘dev,stg’]
created_at생성 일시2024-05-19T00:23:17Z
description설명
name접근제어명DenyTest

1.23.3 - 1.1

scp-cli application-apigateway access control list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

접근제어 목록을 조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
id접근제어 ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr허용 IP 주소[‘127.0.0.1/24,192.168.127.12’]
connected_stages연결된 스테이지[‘dev,stg’]
created_at생성 일시2024-05-19T00:23:17Z
description설명
name접근제어명DenyTest

1.23.4 - 1.0

scp-cli application-apigateway access control list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

접근제어 목록을 조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
id접근제어 ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr허용 IP 주소[‘127.0.0.1/24,192.168.127.12’]
connected_stages연결된 스테이지[‘dev,stg’]
created_at생성 일시2024-05-19T00:23:17Z
description설명
name접근제어명DenyTest

1.24 - List Api Deployments

1.24.1 - 1.3

scp-cli application-apigateway api deployment list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--deployment_id <value>]
[--stage_name <value>]

Description

API 배포 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
deployment_id
optional
string이름27bb070b564349f8a31cc60734cc36a5
stage_name
optional
string스테이지명test-stage

Responses

NameDescriptionExample
deployment_date배포 일시2024-05-17T00:23:17Z
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
status상태Active

1.24.2 - 1.2

scp-cli application-apigateway api deployment list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--deployment_id <value>]
[--stage_name <value>]

Description

API 배포 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
deployment_id
optional
string이름27bb070b564349f8a31cc60734cc36a5
stage_name
optional
string스테이지명test-stage

Responses

NameDescriptionExample
deployment_date배포 일시2024-05-17T00:23:17Z
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
status상태Active

1.24.3 - 1.1

scp-cli application-apigateway api deployment list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--deployment_id <value>]
[--stage_name <value>]

Description

API 배포 목록을 조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
deployment_id
optional
string이름27bb070b564349f8a31cc60734cc36a5
stage_name
optional
string스테이지명test-stage

Responses

NameDescriptionExample
deployment_date배포 일시2024-05-17T00:23:17Z
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
status상태Active

1.24.4 - 1.0

scp-cli application-apigateway api deployment list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--deployment_id <value>]
[--stage_name <value>]

Description

API 배포 목록을 조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
deployment_id
optional
string이름27bb070b564349f8a31cc60734cc36a5
stage_name
optional
string스테이지명test-stage

Responses

NameDescriptionExample
deployment_date배포 일시2024-05-17T00:23:17Z
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
status상태Active

1.25 - List Api Keys

1.25.1 - 1.3

scp-cli application-apigateway api key list
--usage_plan_id <value>
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

API Key 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string이름api-key-name

Responses

NameDescriptionExample
idAPI Key ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시
description설명description
keyKeykey
name이름api-key-name

1.25.2 - 1.2

scp-cli application-apigateway api key list
--usage_plan_id <value>
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

API Key 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string이름api-key-name

Responses

NameDescriptionExample
idAPI Key ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시
description설명description
keyKeykey
name이름api-key-name

1.25.3 - 1.1

scp-cli application-apigateway api key list
--usage_plan_id <value>
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

API Key 목록을 조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string이름api-key-name

Responses

NameDescriptionExample
idAPI Key ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시
description설명description
keyKeykey
name이름api-key-name

1.26 - List Apis

1.26.1 - 1.3

scp-cli application-apigateway api list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

API 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string이름test-api

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_id계정 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
description설명Description
dns_record_statusDNS 레코드 상태Active
name이름test-api
statusAPI 상태Active

1.26.2 - 1.2

scp-cli application-apigateway api list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

API 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string이름test-api

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_id계정 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
description설명Description
dns_record_statusDNS 레코드 상태Active
name이름test-api
statusAPI 상태Active

1.26.3 - 1.1

scp-cli application-apigateway api list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

API 목록을 조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string이름test-api

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_id계정 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
description설명Description
dns_record_statusDNS 레코드 상태Active
name이름test-api
statusAPI 상태Active

1.26.4 - 1.0

scp-cli application-apigateway api list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

API 목록을 조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string이름test-api

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_id계정 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
description설명Description
dns_record_statusDNS 레코드 상태Active
name이름test-api
statusAPI 상태Active

1.27 - List Auths

1.27.1 - 1.3

scp-cli application-apigateway auth list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

인증 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
id인증 ID27bb070b564349f8a31cc60734cc36a5
auth_method인증 수단JWT(JSON WEB Token)
connected_stages연결된 스테이지[‘dev,stg’]
expired_at만료 예정 일시2024-05-17T00:23:17Z
name인증명Token01

1.27.2 - 1.2

scp-cli application-apigateway auth list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

인증 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
id인증 ID27bb070b564349f8a31cc60734cc36a5
auth_method인증 수단JWT(JSON WEB Token)
connected_stages연결된 스테이지[‘dev,stg’]
expired_at만료 예정 일시2024-05-17T00:23:17Z
name인증명Token01

1.27.3 - 1.1

scp-cli application-apigateway auth list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

인증 목록을 조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
id인증 ID27bb070b564349f8a31cc60734cc36a5
auth_method인증 수단JWT(JSON WEB Token)
connected_stages연결된 스테이지[‘dev,stg’]
expired_at만료 예정 일시2024-05-17T00:23:17Z
name인증명Token01

1.27.4 - 1.0

scp-cli application-apigateway auth list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

인증 목록을 조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID-
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
id인증 ID27bb070b564349f8a31cc60734cc36a5
auth_method인증 수단JWT(JSON WEB Token)
connected_stages연결된 스테이지[‘dev,stg’]
expired_at만료 예정 일시2024-05-17T00:23:17Z
name인증명Token01

1.28 - List Connected PrivateLink Endpoints

1.28.1 - 1.3

scp-cli application-apigateway api connected endpoint list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

연결요청된 PrivateLink 엔드포인트를 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
statusPrivateLink 엔드포인트 상태Active

1.28.2 - 1.2

scp-cli application-apigateway api connected endpoint list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]

Description

연결요청된 PrivateLink 엔드포인트를 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc

Responses

NameDescriptionExample
idPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
statusPrivateLink 엔드포인트 상태Active

1.29 - List Methods

1.29.1 - 1.3

scp-cli application-apigateway method list
--resource_id <value>
--api_id <value>

Description

메서드 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
api_key_requiredAPI Key 사용여부False
endpoint_url메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
iam_enabledIAM 정책 적용여부False
integration_type메서드 통합 유형HTTP
method_type메서드 유형GET
privatelink_endpoint_idPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
query_strings메서드 쿼리 문자열{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers메서드 요청 헤더{’test1’ : True}
request_path메서드 요청 경로{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.29.2 - 1.2

scp-cli application-apigateway method list
--resource_id <value>
--api_id <value>

Description

메서드 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
api_key_requiredAPI Key 사용여부False
endpoint_url메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_type메서드 통합 유형HTTP
method_type메서드 유형GET
privatelink_endpoint_idPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
query_strings메서드 쿼리 문자열{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers메서드 요청 헤더{’test1’ : True}
request_path메서드 요청 경로{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.29.3 - 1.1

scp-cli application-apigateway method list
--resource_id <value>
--api_id <value>

Description

메서드 목록을 조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
api_key_requiredAPI Key 사용여부False
endpoint_url메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_type메서드 통합 유형HTTP
method_type메서드 유형GET
query_strings메서드 쿼리 문자열{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers메서드 요청 헤더{’test1’ : True}
request_path메서드 요청 경로{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.29.4 - 1.0

scp-cli application-apigateway method list
--resource_id <value>
--api_id <value>

Description

메서드 목록을 조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
endpoint_url메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
integration_type메서드 통합 유형HTTP
method_type메서드 유형GET
query_strings메서드 쿼리 문자열{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers메서드 요청 헤더{’test1’ : True}
request_path메서드 요청 경로{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.30 - List PrivateLink Endpoints

1.30.1 - 1.3

scp-cli application-apigateway privatelink endpoint list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

PrivateLink 엔드포인트 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPrivateLink 엔드포인트명endpoint

Responses

NameDescriptionExample
idPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
namePrivateLink 엔드포인트명endpoint
privatelink_service_idPrivateLink 서비스 ID27bb070b564349f8a31cc60734cc36a5
statusPrivateLink 엔드포인트 상태CANCELED

1.30.2 - 1.2

scp-cli application-apigateway privatelink endpoint list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

PrivateLink 엔드포인트 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
stringPrivateLink 엔드포인트명endpoint

Responses

NameDescriptionExample
idPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
namePrivateLink 엔드포인트명endpoint
privatelink_service_idPrivateLink 서비스 ID27bb070b564349f8a31cc60734cc36a5
statusPrivateLink 엔드포인트 상태CANCELED

1.31 - List Reports

1.31.1 - 1.3

scp-cli application-apigateway report list
--api_id <value>
--end_date <value>
--start_date <value>
--stage_name <value>

Description

Report 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
end_date
required
string종료일자2025-07-30
start_date
required
string시작일자2025-07-01
stage_name
required
string스테이지명test-stage

Responses

NameDescriptionExample
call_count호출 수10
date날짜
error_4xx_count4xx 에러 수10
error_5xx_count5xx 에러 수10
integration_latency통합 지연시간10
latency지연시간10

1.31.2 - 1.2

scp-cli application-apigateway report list
--api_id <value>
--end_date <value>
--start_date <value>
--stage_name <value>

Description

Report 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
end_date
required
string종료일자2025-07-30
start_date
required
string시작일자2025-07-01
stage_name
required
string스테이지명test-stage

Responses

NameDescriptionExample
call_count호출 수10
date날짜
error_4xx_count4xx 에러 수10
error_5xx_count5xx 에러 수10
integration_latency통합 지연시간10
latency지연시간10

1.31.3 - 1.1

scp-cli application-apigateway report list
--api_id <value>
--end_date <value>
--start_date <value>
--stage_name <value>

Description

Report 목록을 조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
end_date
required
string종료일자2025-07-30
start_date
required
string시작일자2025-07-01
stage_name
required
string스테이지명test-stage

Responses

NameDescriptionExample
call_count호출 수10
date날짜
error_4xx_count4xx 에러 수10
error_5xx_count5xx 에러 수10
integration_latency통합 지연시간10
latency지연시간10

1.32 - List Resources

1.32.1 - 1.3

scp-cli application-apigateway resource list
--api_id <value>

Description

리소스 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
id리소스 ID27bb070b564349f8a31cc60734cc36a5
methods
parent_id부모 리소스 ID27bb070b564349f8a31cc60734cc36a5
path경로/test/test1
path_part경로명test

1.32.2 - 1.2

scp-cli application-apigateway resource list
--api_id <value>

Description

리소스 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
id리소스 ID27bb070b564349f8a31cc60734cc36a5
methods
parent_id부모 리소스 ID27bb070b564349f8a31cc60734cc36a5
path경로/test/test1
path_part경로명test

1.32.3 - 1.1

scp-cli application-apigateway resource list
--api_id <value>

Description

리소스 목록을 조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
id리소스 ID27bb070b564349f8a31cc60734cc36a5
methods
parent_id부모 리소스 ID27bb070b564349f8a31cc60734cc36a5
path경로/test/test1
path_part경로명test

1.32.4 - 1.0

scp-cli application-apigateway resource list
--api_id <value>

Description

리소스 목록을 조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
id리소스 ID27bb070b564349f8a31cc60734cc36a5
methods
parent_id부모 리소스 ID27bb070b564349f8a31cc60734cc36a5
path경로/test/test1
path_part경로명test

1.33 - List Stages

1.33.1 - 1.3

scp-cli application-apigateway stage list
--api_id <value>

Description

스테이지 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
active_deployment활성화 배포2024-05-17T00:23:17Z
allow_credentials허용 인증True
allow_headers허용 헤더[‘Content-Type’, ‘Authorization’]
allow_methods허용 메서드[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins허용 원본[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_summaryAPI 요약[{‘methods’: [{‘api_key_required’: True, ‘iam_enabled’: True, ’type’: ‘GET’}, {‘api_key_required’: False, ‘iam_enabled’: False, ’type’: ‘POST’}], ‘path’: ‘/’}, {‘methods’: [{‘api_key_required’: True, ‘iam_enabled’: True, ’type’: ‘GET’}, {‘api_key_required’: False, ‘iam_enabled’: False, ’type’: ‘POST’}], ‘path’: ‘/test’}]
cors_enabledCORS 사용여부False
created_at생성 일시
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
expose_headers노출 헤더[’test1’, ’test2’]
invoke_url호출 URLhttp://test.com/stg
jwt_enabledJWT 사용여부False
max_age최대 캐시 기간3600
name스테이지명test-stage
usage_plan_api_keysAPI Key[]
usage_plan_id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limit사용량 정책 할당량10
usage_plan_name이름usage-plan-name
usage_plan_rate사용량 정책 주기day

1.33.2 - 1.2

scp-cli application-apigateway stage list
--api_id <value>

Description

스테이지 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
active_deployment활성화 배포2024-05-17T00:23:17Z
allow_credentials허용 인증True
allow_headers허용 헤더[‘Content-Type’, ‘Authorization’]
allow_methods허용 메서드[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins허용 원본[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredAPI Key 사용여부False
api_summaryAPI 요약[{‘methods’: [{‘api_key_required’: True, ’type’: ‘GET’}, {‘api_key_required’: False, ’type’: ‘POST’}], ‘path’: ‘/’}, {‘methods’: [{‘api_key_required’: True, ’type’: ‘GET’}, {‘api_key_required’: False, ’type’: ‘POST’}], ‘path’: ‘/test’}]
cors_enabledCORS 사용여부False
created_at생성 일시
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
expose_headers노출 헤더[’test1’, ’test2’]
invoke_url호출 URLhttp://test.com/stg
jwt_enabledJWT 사용여부False
max_age최대 캐시 기간3600
name스테이지명test-stage
usage_plan_api_keysAPI Key[]
usage_plan_id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limit사용량 정책 할당량10
usage_plan_name이름usage-plan-name
usage_plan_rate사용량 정책 주기day

1.33.3 - 1.1

scp-cli application-apigateway stage list
--api_id <value>

Description

스테이지 목록을 조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
active_deployment활성화 배포2024-05-17T00:23:17Z
allow_credentials허용 인증True
allow_headers허용 헤더[‘Content-Type’, ‘Authorization’]
allow_methods허용 메서드[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins허용 원본[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredAPI Key 사용여부False
api_summaryAPI 요약[{‘methods’: [{‘api_key_required’: True, ’type’: ‘GET’}, {‘api_key_required’: False, ’type’: ‘POST’}], ‘path’: ‘/’}, {‘methods’: [{‘api_key_required’: True, ’type’: ‘GET’}, {‘api_key_required’: False, ’type’: ‘POST’}], ‘path’: ‘/test’}]
cors_enabledCORS 사용여부False
created_at생성 일시
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
expose_headers노출 헤더[’test1’, ’test2’]
invoke_url호출 URLhttp://test.com/stg
jwt_enabledJWT 사용여부False
max_age최대 캐시 기간3600
name스테이지명test-stage
usage_plan_api_keysAPI Key[]
usage_plan_id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limit사용량 정책 할당량10
usage_plan_name이름usage-plan-name
usage_plan_rate사용량 정책 주기day

1.33.4 - 1.0

scp-cli application-apigateway stage list
--api_id <value>

Description

스테이지 목록을 조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
active_deployment활성화 배포2024-05-17T00:23:17Z
allow_credentials허용 인증True
allow_headers허용 헤더[‘Content-Type’, ‘Authorization’]
allow_methods허용 메서드[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins허용 원본[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_summaryAPI 요약[{‘methods’: [‘GET’, ‘POST’], ‘path’: ‘/’}, {‘methods’: [‘GET’, ‘POST’], ‘path’: ‘/test’}]
cors_enabledCORS 사용여부False
created_at생성 일시
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
expose_headers노출 헤더[’test1’, ’test2’]
invoke_url호출 URLhttp://test.com/stg
ip_restriction_enabledIP 접근제어 사용여부False
jwt_enabledJWT 사용여부False
max_age최대 캐시 기간3600
name스테이지명test-stage

1.34 - List Usage Plans

1.34.1 - 1.3

scp-cli application-apigateway usage plan list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

사용량 정책 목록을 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string이름usage-plan-name

Responses

NameDescriptionExample
id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
connected_api_keys연결된 API Key 목록[‘key1’, ‘key2’]
created_at생성 일시
description설명description
limit사용량 정책 할당량10
name이름usage-plan-name
rate사용량 정책 주기day

1.34.2 - 1.2

scp-cli application-apigateway usage plan list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

사용량 정책 목록을 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string이름usage-plan-name

Responses

NameDescriptionExample
id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
connected_api_keys연결된 API Key 목록[‘key1’, ‘key2’]
created_at생성 일시
description설명description
limit사용량 정책 할당량10
name이름usage-plan-name
rate사용량 정책 주기day

1.34.3 - 1.1

scp-cli application-apigateway usage plan list
--api_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]

Description

사용량 정책 목록을 조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
size
optional
integersize20
page
optional
integerpage0
sort
optional
stringsortcreated_at:desc
name
optional
string이름usage-plan-name

Responses

NameDescriptionExample
id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
connected_api_keys연결된 API Key 목록[‘key1’, ‘key2’]
created_at생성 일시
description설명description
limit사용량 정책 할당량10
name이름usage-plan-name
rate사용량 정책 주기day

1.35 - Request PrivateLink Endpoint

1.35.1 - 1.3

scp-cli application-apigateway privatelink endpoint request
--privatelink_endpoint_id <value>
--type <value>

Description

PrivateLink 엔드포인트를 요청한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
type
required
stringPrivateLink 엔드포인트 액션 유형CANCEL

1.35.2 - 1.2

scp-cli application-apigateway privatelink endpoint request
--privatelink_endpoint_id <value>
--type <value>

Description

PrivateLink 엔드포인트를 요청한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
type
required
stringPrivateLink 엔드포인트 액션 유형CANCEL

1.36 - Set Access Control

1.36.1 - 1.3

scp-cli application-apigateway access control set
--access_control_id <value>
--api_id <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

접근제어를 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
access_control_id
required
string접근제어 ID-
api_id
required
stringApi ID-
connected_stages
required
array연결된 스테이지dev,stg
allowed_ip_addr
required
array허용 IP 주소127.0.0.1/24,192.168.127.12
description
optional
string설명description

1.36.2 - 1.2

scp-cli application-apigateway access control set
--access_control_id <value>
--api_id <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

접근제어를 수정한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
access_control_id
required
string접근제어 ID-
api_id
required
stringApi ID-
connected_stages
required
array연결된 스테이지dev,stg
allowed_ip_addr
required
array허용 IP 주소127.0.0.1/24,192.168.127.12
description
optional
string설명description

1.36.3 - 1.1

scp-cli application-apigateway access control set
--access_control_id <value>
--api_id <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

접근제어를 수정한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
access_control_id
required
string접근제어 ID-
api_id
required
stringApi ID-
connected_stages
required
array연결된 스테이지dev,stg
allowed_ip_addr
required
array허용 IP 주소127.0.0.1/24,192.168.127.12
description
optional
string설명description

1.36.4 - 1.0

scp-cli application-apigateway access control set
--access_control_id <value>
--api_id <value>
--connected_stages <value>
--allowed_ip_addr <value>
[--description <value>]

Description

접근제어를 수정한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
access_control_id
required
string접근제어 ID-
api_id
required
stringApi ID-
connected_stages
required
array연결된 스테이지dev,stg
allowed_ip_addr
required
array허용 IP 주소127.0.0.1/24,192.168.127.12
description
optional
string설명description

1.37 - Set Api Description

1.37.1 - 1.3

scp-cli application-apigateway api description set
--api_id <value>
[--description <value>]

Description

API 설명을 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
description
optional
string설명description

1.37.2 - 1.2

scp-cli application-apigateway api description set
--api_id <value>
[--description <value>]

Description

API 설명을 수정한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
description
optional
string설명description

1.37.3 - 1.1

scp-cli application-apigateway api description set
--api_id <value>
[--description <value>]

Description

API 설명을 수정한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
description
optional
string설명description

1.37.4 - 1.0

scp-cli application-apigateway api description set
--api_id <value>
[--description <value>]

Description

API 설명을 수정한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b
description
optional
string설명description

1.38 - Set API Key Description

1.38.1 - 1.3

scp-cli application-apigateway api key set
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>
[--description <value>]

Description

API Key 설명을 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_key_id
required
stringAPI Key ID27bb070b564349f8a31cc60734cc36a5
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
description
optional
string설명description

1.38.2 - 1.2

scp-cli application-apigateway api key set
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>
[--description <value>]

Description

API Key 설명을 수정한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_key_id
required
stringAPI Key ID27bb070b564349f8a31cc60734cc36a5
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
description
optional
string설명description

1.38.3 - 1.1

scp-cli application-apigateway api key set
--api_key_id <value>
--usage_plan_id <value>
--api_id <value>
[--description <value>]

Description

API Key 설명을 수정한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_key_id
required
stringAPI Key ID27bb070b564349f8a31cc60734cc36a5
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
description
optional
string설명description

1.39 - Set Auth

1.39.1 - 1.3

scp-cli application-apigateway auth set
--auth_id <value>
--api_id <value>
--connected_stages <value>

Description

인증을 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
auth_id
required
string인증 ID-
api_id
required
stringApi ID-
connected_stages
required
array연결된 스테이지dev,stg

1.39.2 - 1.2

scp-cli application-apigateway auth set
--auth_id <value>
--api_id <value>
--connected_stages <value>

Description

인증을 수정한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
auth_id
required
string인증 ID-
api_id
required
stringApi ID-
connected_stages
required
array연결된 스테이지dev,stg

1.39.3 - 1.1

scp-cli application-apigateway auth set
--auth_id <value>
--api_id <value>
--connected_stages <value>

Description

인증을 수정한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
auth_id
required
string인증 ID-
api_id
required
stringApi ID-
connected_stages
required
array연결된 스테이지dev,stg

1.39.4 - 1.0

scp-cli application-apigateway auth set
--auth_id <value>
--api_id <value>
--connected_stages <value>

Description

인증을 수정한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
auth_id
required
string인증 ID-
api_id
required
stringApi ID-
connected_stages
required
array연결된 스테이지dev,stg

1.40 - Set Method

1.40.1 - 1.3

scp-cli 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>
[--endpoint_url <value>]
[--function_id <value>]
[--privatelink_endpoint_id <value>]

Description

메서드를 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
method_type
required
****메서드 유형GET
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
request_headers
required
dict메서드 요청 헤더{'test1' : True}
query_strings
required
dict메서드 쿼리 문자열{'param1': 'value1', 'param2': 'value2'}
integration_type
required
string메서드 통합 유형HTTP
iam_enabled
required
booleanIAM 정책 적용여부False
api_key_required
required
booleanAPI Key 사용여부False
endpoint_url
optional
string메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
privatelink_endpoint_id
optional
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5

1.40.2 - 1.2

scp-cli application-apigateway method set
--method_type <value>
--resource_id <value>
--api_id <value>
--request_headers <value>
--query_strings <value>
--integration_type <value>
--api_key_required <value>
[--endpoint_url <value>]
[--function_id <value>]
[--privatelink_endpoint_id <value>]

Description

메서드를 수정한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
method_type
required
****메서드 유형GET
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
request_headers
required
dict메서드 요청 헤더{'test1' : True}
query_strings
required
dict메서드 쿼리 문자열{'param1': 'value1', 'param2': 'value2'}
integration_type
required
string메서드 통합 유형HTTP
api_key_required
required
booleanAPI Key 사용여부False
endpoint_url
optional
string메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
privatelink_endpoint_id
optional
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5

1.40.3 - 1.1

scp-cli application-apigateway method set
--method_type <value>
--resource_id <value>
--api_id <value>
--request_headers <value>
--query_strings <value>
--integration_type <value>
--api_key_required <value>
[--endpoint_url <value>]
[--function_id <value>]
[--privatelink_endpoint_id <value>]

Description

메서드를 수정한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
method_type
required
****메서드 유형GET
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
request_headers
required
dict메서드 요청 헤더{'test1' : True}
query_strings
required
dict메서드 쿼리 문자열{'param1': 'value1', 'param2': 'value2'}
integration_type
required
string메서드 통합 유형HTTP
api_key_required
required
booleanAPI Key 사용여부False
endpoint_url
optional
string메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_id
optional
stringCloud Function ID27bb070b564349f8a31cc60734cc36a5
privatelink_endpoint_id
optional
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5

1.40.4 - 1.0

scp-cli application-apigateway method set
--method_type <value>
--resource_id <value>
--api_id <value>
--request_headers <value>
--query_strings <value>

Description

메서드를 수정한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
method_type
required
****메서드 유형GET
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
request_headers
required
dict메서드 요청 헤더{'test1' : True}
query_strings
required
dict메서드 쿼리 문자열{'param1': 'value1', 'param2': 'value2'}

1.41 - Set PrivateLink Endpoint

1.41.1 - 1.3

scp-cli application-apigateway privatelink endpoint set
--privatelink_endpoint_id <value>
[--description <value>]

Description

PrivateLink 엔드포인트를 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
description
optional
string설명description

1.41.2 - 1.2

scp-cli application-apigateway privatelink endpoint set
--privatelink_endpoint_id <value>
[--description <value>]

Description

PrivateLink 엔드포인트를 수정한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
description
optional
string설명description

1.42 - Set Resource Policy

1.42.1 - 1.3

scp-cli application-apigateway resource policy set
--api_id <value>
--version <value>
--statement <value>

Description

리소스 정책을 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
version
required
string버전2024-07-01
statement
required
arrayStatement'{"Action": ["iam:*"], "Condition": {"StringEquals": {"scp:RequestedRegion": ["kr-west1"]}}, "Effect": "Allow", "NotAction": [], "Principal": [], "Resource": ["*"], "Sid": "Statement1"}'

1.43 - Set Stage Active Deployment

1.43.1 - 1.3

scp-cli application-apigateway stage set active deployment
--api_id <value>
--stage_name <value>
--deployment_id <value>

Description

스테이지 활성화 배포를 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage
deployment_id
required
string배포 ID27bb070b564349f8a31cc60734cc36a5

1.43.2 - 1.2

scp-cli application-apigateway stage set active deployment
--api_id <value>
--stage_name <value>
--deployment_id <value>

Description

스테이지 활성화 배포를 수정한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage
deployment_id
required
string배포 ID27bb070b564349f8a31cc60734cc36a5

1.43.3 - 1.1

scp-cli application-apigateway stage set active deployment
--api_id <value>
--stage_name <value>
--deployment_id <value>

Description

스테이지 활성화 배포를 수정한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage
deployment_id
required
string배포 ID27bb070b564349f8a31cc60734cc36a5

1.43.4 - 1.0

scp-cli application-apigateway stage set active deployment
--api_id <value>
--stage_name <value>
--deployment_id <value>

Description

스테이지 활성화 배포를 수정한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage
deployment_id
required
string배포 ID27bb070b564349f8a31cc60734cc36a5

1.44 - Set Stage Configuration

1.44.1 - 1.3

scp-cli application-apigateway stage set configuration
--api_id <value>
--stage_name <value>
--jwt_enabled <value>
--cors_enabled <value>
[--allow_credentials <value>]
[--allow_headers <value>]
[--allow_methods <value>]
[--allow_origins <value>]
[--connected_api_keys <value>]
[--description <value>]
[--expose_headers <value>]
[--max_age <value>]
[--usage_plan_id <value>]

Description

스테이지 설정을 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage
jwt_enabled
required
booleanJWT 사용여부False
cors_enabled
required
booleanCORS 사용여부False
allow_credentials
optional
boolean허용 인증True
allow_headers
optional
array허용 헤더Content-Type
allow_methods
optional
array허용 메서드'{}'
allow_origins
optional
array허용 원본*
connected_api_keys
optional
array연결된 API Key 목록key1
description
optional
string설명description
expose_headers
optional
array노출 헤더test1
max_age
optional
integer최대 캐시 기간3600
usage_plan_id
optional
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5

1.44.2 - 1.2

scp-cli application-apigateway stage set configuration
--api_id <value>
--stage_name <value>
--jwt_enabled <value>
--cors_enabled <value>
[--allow_credentials <value>]
[--allow_headers <value>]
[--allow_methods <value>]
[--allow_origins <value>]
[--connected_api_keys <value>]
[--description <value>]
[--expose_headers <value>]
[--max_age <value>]
[--usage_plan_id <value>]

Description

스테이지 설정을 수정한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage
jwt_enabled
required
booleanJWT 사용여부False
cors_enabled
required
booleanCORS 사용여부False
allow_credentials
optional
boolean허용 인증True
allow_headers
optional
array허용 헤더Content-Type
allow_methods
optional
array허용 메서드'{}'
allow_origins
optional
array허용 원본*
connected_api_keys
optional
array연결된 API Key 목록key1
description
optional
string설명description
expose_headers
optional
array노출 헤더test1
max_age
optional
integer최대 캐시 기간3600
usage_plan_id
optional
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5

1.44.3 - 1.1

scp-cli application-apigateway stage set configuration
--api_id <value>
--stage_name <value>
--jwt_enabled <value>
--cors_enabled <value>
[--allow_credentials <value>]
[--allow_headers <value>]
[--allow_methods <value>]
[--allow_origins <value>]
[--connected_api_keys <value>]
[--description <value>]
[--expose_headers <value>]
[--max_age <value>]
[--usage_plan_id <value>]

Description

스테이지 설정을 수정한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage
jwt_enabled
required
booleanJWT 사용여부False
cors_enabled
required
booleanCORS 사용여부False
allow_credentials
optional
boolean허용 인증True
allow_headers
optional
array허용 헤더Content-Type
allow_methods
optional
array허용 메서드'{}'
allow_origins
optional
array허용 원본*
connected_api_keys
optional
array연결된 API Key 목록key1
description
optional
string설명description
expose_headers
optional
array노출 헤더test1
max_age
optional
integer최대 캐시 기간3600
usage_plan_id
optional
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5

1.44.4 - 1.0

scp-cli application-apigateway stage set configuration
--api_id <value>
--stage_name <value>
--jwt_enabled <value>
--ip_restriction_enabled <value>
--cors_enabled <value>
[--allow_credentials <value>]
[--allow_headers <value>]
[--allow_methods <value>]
[--allow_origins <value>]
[--expose_headers <value>]
[--max_age <value>]

Description

스테이지 설정을 수정한다(ip_restriction_enabled 수정은 더 이상 지원되지 않음)

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage
jwt_enabled
required
booleanJWT 사용여부False
ip_restriction_enabled
required
booleanIP 접근제어 사용여부False
cors_enabled
required
booleanCORS 사용여부False
allow_credentials
optional
boolean허용 인증True
allow_headers
optional
array허용 헤더Content-Type
allow_methods
optional
array허용 메서드'{}'
allow_origins
optional
array허용 원본*
expose_headers
optional
array노출 헤더test1
max_age
optional
integer최대 캐시 기간3600

1.45 - Set Usage Plan Description

1.45.1 - 1.3

scp-cli application-apigateway usage plan set description
--usage_plan_id <value>
--api_id <value>
[--description <value>]

Description

사용량 정책 설명을 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
description
optional
string설명description

1.45.2 - 1.2

scp-cli application-apigateway usage plan set description
--usage_plan_id <value>
--api_id <value>
[--description <value>]

Description

사용량 정책 설명을 수정한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
description
optional
string설명description

1.45.3 - 1.1

scp-cli application-apigateway usage plan set description
--usage_plan_id <value>
--api_id <value>
[--description <value>]

Description

사용량 정책 설명을 수정한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
description
optional
string설명description

1.46 - Set Usage Plan Quota

1.46.1 - 1.3

scp-cli application-apigateway usage plan set quota
--usage_plan_id <value>
--api_id <value>
--rate <value>
--limit <value>

Description

사용량 정책 할당량을 수정한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
rate
required
string사용량 정책 주기day
limit
required
integer사용량 정책 할당량10

1.46.2 - 1.2

scp-cli application-apigateway usage plan set quota
--usage_plan_id <value>
--api_id <value>
--rate <value>
--limit <value>

Description

사용량 정책 할당량을 수정한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
rate
required
string사용량 정책 주기day
limit
required
integer사용량 정책 할당량10

1.46.3 - 1.1

scp-cli application-apigateway usage plan set quota
--usage_plan_id <value>
--api_id <value>
--rate <value>
--limit <value>

Description

사용량 정책 할당량을 수정한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
rate
required
string사용량 정책 주기day
limit
required
integer사용량 정책 할당량10

1.47 - Show Access Control

1.47.1 - 1.3

scp-cli application-apigateway access control show
--access_control_id <value>
--api_id <value>

Description

접근제어를 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
access_control_id
required
string접근제어 ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
id접근제어 ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr허용 IP 주소[‘127.0.0.1/24,192.168.127.12’]
connected_stages연결된 스테이지[‘dev,stg’]
created_at생성 일시2024-05-19T00:23:17Z
description설명
name접근제어명DenyTest

1.47.2 - 1.2

scp-cli application-apigateway access control show
--access_control_id <value>
--api_id <value>

Description

접근제어를 상세조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
access_control_id
required
string접근제어 ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
id접근제어 ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr허용 IP 주소[‘127.0.0.1/24,192.168.127.12’]
connected_stages연결된 스테이지[‘dev,stg’]
created_at생성 일시2024-05-19T00:23:17Z
description설명
name접근제어명DenyTest

1.47.3 - 1.1

scp-cli application-apigateway access control show
--access_control_id <value>
--api_id <value>

Description

접근제어를 상세조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
access_control_id
required
string접근제어 ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
id접근제어 ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr허용 IP 주소[‘127.0.0.1/24,192.168.127.12’]
connected_stages연결된 스테이지[‘dev,stg’]
created_at생성 일시2024-05-19T00:23:17Z
description설명
name접근제어명DenyTest

1.47.4 - 1.0

scp-cli application-apigateway access control show
--access_control_id <value>
--api_id <value>

Description

접근제어를 상세조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
access_control_id
required
string접근제어 ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
id접근제어 ID27bb070b564349f8a31cc60734cc36a5
allowed_ip_addr허용 IP 주소[‘127.0.0.1/24,192.168.127.12’]
connected_stages연결된 스테이지[‘dev,stg’]
created_at생성 일시2024-05-19T00:23:17Z
description설명
name접근제어명DenyTest

1.48 - Show Api

1.48.1 - 1.3

scp-cli application-apigateway api show
--api_id <value>

Description

API를 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_id계정 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
description설명Description
dns_record_statusDNS 레코드 상태Active
name이름test-api
statusAPI 상태Active

1.48.2 - 1.2

scp-cli application-apigateway api show
--api_id <value>

Description

API를 상세조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_id계정 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
description설명Description
dns_record_statusDNS 레코드 상태Active
name이름test-api
statusAPI 상태Active

1.48.3 - 1.1

scp-cli application-apigateway api show
--api_id <value>

Description

API를 상세조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_id계정 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
description설명Description
dns_record_statusDNS 레코드 상태Active
name이름test-api
statusAPI 상태Active

1.48.4 - 1.0

scp-cli application-apigateway api show
--api_id <value>

Description

API를 상세조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID31e749b7b260868f441e862b

Responses

NameDescriptionExample
idApi ID27bb070b564349f8a31cc60734cc36a5
account_id계정 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
description설명Description
dns_record_statusDNS 레코드 상태Active
name이름test-api
statusAPI 상태Active

1.49 - Show Auth

1.49.1 - 1.3

scp-cli application-apigateway auth show
--auth_id <value>
--api_id <value>

Description

인증을 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
auth_id
required
string인증 ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
id인증 ID27bb070b564349f8a31cc60734cc36a5
auth_method인증 수단JWT(JSON WEB Token)
connected_stages연결된 스테이지[‘dev,stg’]
expired_at만료 예정 일시2024-05-17T00:23:17Z
name인증명Token01

1.49.2 - 1.2

scp-cli application-apigateway auth show
--auth_id <value>
--api_id <value>

Description

인증을 상세조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
auth_id
required
string인증 ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
id인증 ID27bb070b564349f8a31cc60734cc36a5
auth_method인증 수단JWT(JSON WEB Token)
connected_stages연결된 스테이지[‘dev,stg’]
expired_at만료 예정 일시2024-05-17T00:23:17Z
name인증명Token01

1.49.3 - 1.1

scp-cli application-apigateway auth show
--auth_id <value>
--api_id <value>

Description

인증을 상세조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
auth_id
required
string인증 ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
id인증 ID27bb070b564349f8a31cc60734cc36a5
auth_method인증 수단JWT(JSON WEB Token)
connected_stages연결된 스테이지[‘dev,stg’]
expired_at만료 예정 일시2024-05-17T00:23:17Z
name인증명Token01

1.49.4 - 1.0

scp-cli application-apigateway auth show
--auth_id <value>
--api_id <value>

Description

인증을 상세조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
auth_id
required
string인증 ID-
api_id
required
stringApi ID-

Responses

NameDescriptionExample
id인증 ID27bb070b564349f8a31cc60734cc36a5
auth_method인증 수단JWT(JSON WEB Token)
connected_stages연결된 스테이지[‘dev,stg’]
expired_at만료 예정 일시2024-05-17T00:23:17Z
name인증명Token01

1.50 - Show Method

1.50.1 - 1.3

scp-cli application-apigateway method show
--method_type <value>
--resource_id <value>
--api_id <value>

Description

메서드를 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
method_type
required
****메서드 유형GET
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
api_key_requiredAPI Key 사용여부False
endpoint_url메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
iam_enabledIAM 정책 적용여부False
integration_type메서드 통합 유형HTTP
method_type메서드 유형GET
privatelink_endpoint_idPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
query_strings메서드 쿼리 문자열{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers메서드 요청 헤더{’test1’ : True}
request_path메서드 요청 경로{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.50.2 - 1.2

scp-cli application-apigateway method show
--method_type <value>
--resource_id <value>
--api_id <value>

Description

메서드를 상세조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
method_type
required
****메서드 유형GET
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
api_key_requiredAPI Key 사용여부False
endpoint_url메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_type메서드 통합 유형HTTP
method_type메서드 유형GET
privatelink_endpoint_idPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
query_strings메서드 쿼리 문자열{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers메서드 요청 헤더{’test1’ : True}
request_path메서드 요청 경로{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.50.3 - 1.1

scp-cli application-apigateway method show
--method_type <value>
--resource_id <value>
--api_id <value>

Description

메서드를 상세조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
method_type
required
****메서드 유형GET
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
api_key_requiredAPI Key 사용여부False
endpoint_url메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
function_nameCloud Function Nametest-function
integration_type메서드 통합 유형HTTP
method_type메서드 유형GET
query_strings메서드 쿼리 문자열{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers메서드 요청 헤더{’test1’ : True}
request_path메서드 요청 경로{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.50.4 - 1.0

scp-cli application-apigateway method show
--method_type <value>
--resource_id <value>
--api_id <value>

Description

메서드를 상세조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
method_type
required
****메서드 유형GET
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
endpoint_url메서드 엔드포인트 URLhttps://127.0.0.1:8000
function_idCloud Function ID27bb070b564349f8a31cc60734cc36a5
integration_type메서드 통합 유형HTTP
method_type메서드 유형GET
query_strings메서드 쿼리 문자열{‘param1’: ‘value1’, ‘param2’: ‘value2’}
request_headers메서드 요청 헤더{’test1’ : True}
request_path메서드 요청 경로{users}
srnSRNsrn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test

1.51 - Show PrivateLink Endpoint

1.51.1 - 1.3

scp-cli application-apigateway privatelink endpoint show
--privatelink_endpoint_id <value>

Description

PrivateLink 엔드포인트를 조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
description설명description
namePrivateLink 엔드포인트명endpoint
privatelink_service_idPrivateLink 서비스 ID27bb070b564349f8a31cc60734cc36a5
statusPrivateLink 엔드포인트 상태CANCELED

1.51.2 - 1.2

scp-cli application-apigateway privatelink endpoint show
--privatelink_endpoint_id <value>

Description

PrivateLink 엔드포인트를 조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
privatelink_endpoint_id
required
stringPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
idPrivateLink 엔드포인트 ID27bb070b564349f8a31cc60734cc36a5
created_at생성 일시2024-05-17T00:23:17Z
description설명description
namePrivateLink 엔드포인트명endpoint
privatelink_service_idPrivateLink 서비스 ID27bb070b564349f8a31cc60734cc36a5
statusPrivateLink 엔드포인트 상태CANCELED

1.52 - Show Resource

1.52.1 - 1.3

scp-cli application-apigateway resource show
--resource_id <value>
--api_id <value>

Description

리소스를 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
id리소스 ID27bb070b564349f8a31cc60734cc36a5
methods
parent_id부모 리소스 ID27bb070b564349f8a31cc60734cc36a5
path경로/test/test1
path_part경로명test

1.52.2 - 1.2

scp-cli application-apigateway resource show
--resource_id <value>
--api_id <value>

Description

리소스를 상세조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
id리소스 ID27bb070b564349f8a31cc60734cc36a5
methods
parent_id부모 리소스 ID27bb070b564349f8a31cc60734cc36a5
path경로/test/test1
path_part경로명test

1.52.3 - 1.1

scp-cli application-apigateway resource show
--resource_id <value>
--api_id <value>

Description

리소스를 상세조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
id리소스 ID27bb070b564349f8a31cc60734cc36a5
methods
parent_id부모 리소스 ID27bb070b564349f8a31cc60734cc36a5
path경로/test/test1
path_part경로명test

1.52.4 - 1.0

scp-cli application-apigateway resource show
--resource_id <value>
--api_id <value>

Description

리소스를 상세조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
resource_id
required
string리소스 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
id리소스 ID27bb070b564349f8a31cc60734cc36a5
methods
parent_id부모 리소스 ID27bb070b564349f8a31cc60734cc36a5
path경로/test/test1
path_part경로명test

1.53 - Show Resource Policy

1.53.1 - 1.3

scp-cli application-apigateway resource policy show
--api_id <value>

Description

리소스 정책을 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
policy_documentPolicy Document{‘Statement’: [{‘Action’: [‘apigateway:InvokeApigatewayRegion’], ‘Condition’: {‘SrnLike’: {“scp:RequestAttribute/body[‘method-srn’]”: [‘srn:dev2::27bb070b564349f8a31cc60734cc36a5:kr-west1::apigateway:method/a4b19a70b596467fb010d3c3//GET/n-f’]}}, ‘Effect’: ‘Allow’, ‘Principal’: ‘’, ‘Resource’: [‘srn:dev2::27bb070b564349f8a31cc60734cc36a5:kr-west1::apigateway:api/a4b19a70b596467fb010d3c3’], ‘Sid’: ‘Statement1’}], ‘Version’: ‘2024-07-01’}

1.54 - Show Stage

1.54.1 - 1.3

scp-cli application-apigateway stage show
--api_id <value>
--stage_name <value>

Description

스테이지를 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage

Responses

NameDescriptionExample
active_deployment활성화 배포2024-05-17T00:23:17Z
allow_credentials허용 인증True
allow_headers허용 헤더[‘Content-Type’, ‘Authorization’]
allow_methods허용 메서드[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins허용 원본[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
cors_enabledCORS 사용여부False
created_at생성 일시
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
expose_headers노출 헤더[’test1’, ’test2’]
invoke_url호출 URLhttp://test.com/stg
jwt_enabledJWT 사용여부False
max_age최대 캐시 기간3600
name스테이지명test-stage
usage_plan_api_keysAPI Key[]
usage_plan_id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limit사용량 정책 할당량10
usage_plan_name이름usage-plan-name
usage_plan_rate사용량 정책 주기day

1.54.2 - 1.2

scp-cli application-apigateway stage show
--api_id <value>
--stage_name <value>

Description

스테이지를 상세조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage

Responses

NameDescriptionExample
active_deployment활성화 배포2024-05-17T00:23:17Z
allow_credentials허용 인증True
allow_headers허용 헤더[‘Content-Type’, ‘Authorization’]
allow_methods허용 메서드[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins허용 원본[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredAPI Key 사용여부False
cors_enabledCORS 사용여부False
created_at생성 일시
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
expose_headers노출 헤더[’test1’, ’test2’]
invoke_url호출 URLhttp://test.com/stg
jwt_enabledJWT 사용여부False
max_age최대 캐시 기간3600
name스테이지명test-stage
usage_plan_api_keysAPI Key[]
usage_plan_id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limit사용량 정책 할당량10
usage_plan_name이름usage-plan-name
usage_plan_rate사용량 정책 주기day

1.54.3 - 1.1

scp-cli application-apigateway stage show
--api_id <value>
--stage_name <value>

Description

스테이지를 상세조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage

Responses

NameDescriptionExample
active_deployment활성화 배포2024-05-17T00:23:17Z
allow_credentials허용 인증True
allow_headers허용 헤더[‘Content-Type’, ‘Authorization’]
allow_methods허용 메서드[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins허용 원본[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
api_key_requiredAPI Key 사용여부False
cors_enabledCORS 사용여부False
created_at생성 일시
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
description설명description
expose_headers노출 헤더[’test1’, ’test2’]
invoke_url호출 URLhttp://test.com/stg
jwt_enabledJWT 사용여부False
max_age최대 캐시 기간3600
name스테이지명test-stage
usage_plan_api_keysAPI Key[]
usage_plan_id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
usage_plan_limit사용량 정책 할당량10
usage_plan_name이름usage-plan-name
usage_plan_rate사용량 정책 주기day

1.54.4 - 1.0

scp-cli application-apigateway stage show
--api_id <value>
--stage_name <value>

Description

스테이지를 상세조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.020251231

Parameters

NameTypeDescriptionExample
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5
stage_name
required
string스테이지명test-stage

Responses

NameDescriptionExample
active_deployment활성화 배포2024-05-17T00:23:17Z
allow_credentials허용 인증True
allow_headers허용 헤더[‘Content-Type’, ‘Authorization’]
allow_methods허용 메서드[‘GET’, ‘POST’, ‘PUT’, ‘PATCH’]
allow_origins허용 원본[’*’]
api_idApi ID27bb070b564349f8a31cc60734cc36a5
cors_enabledCORS 사용여부False
created_at생성 일시
deployment_id배포 ID27bb070b564349f8a31cc60734cc36a5
expose_headers노출 헤더[’test1’, ’test2’]
invoke_url호출 URLhttp://test.com/stg
ip_restriction_enabledIP 접근제어 사용여부False
jwt_enabledJWT 사용여부False
max_age최대 캐시 기간3600
name스테이지명test-stage

1.55 - Show Usage Plan

1.55.1 - 1.3

scp-cli application-apigateway usage plan show
--usage_plan_id <value>
--api_id <value>

Description

사용량 정책을 상세조회한다

상태 ACTIVE (CURRENT)

버전최소 지원 보장일
1.3-

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_keysAPI Key[]
created_at생성 일시
created_by_id생성자27bb070b564349f8a31cc60734cc36a5
created_by_name생성자username
description설명description
limit사용량 정책 할당량10
modified_at수정시간
modified_by_id수정자27bb070b564349f8a31cc60734cc36a5
modified_by_name수정자username
name이름usage-plan-name
rate사용량 정책 주기day

1.55.2 - 1.2

scp-cli application-apigateway usage plan show
--usage_plan_id <value>
--api_id <value>

Description

사용량 정책을 상세조회한다

상태 ACTIVE (SUPPORTED)

버전최소 지원 보장일
1.220260630

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_keysAPI Key[]
created_at생성 일시
created_by_id생성자27bb070b564349f8a31cc60734cc36a5
created_by_name생성자username
description설명description
limit사용량 정책 할당량10
modified_at수정시간
modified_by_id수정자27bb070b564349f8a31cc60734cc36a5
modified_by_name수정자username
name이름usage-plan-name
rate사용량 정책 주기day

1.55.3 - 1.1

scp-cli application-apigateway usage plan show
--usage_plan_id <value>
--api_id <value>

Description

사용량 정책을 상세조회한다

상태 ACTIVE (DEPRECATED)

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

버전최소 지원 보장일
1.120260430

Parameters

NameTypeDescriptionExample
usage_plan_id
required
string사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_id
required
stringApi ID27bb070b564349f8a31cc60734cc36a5

Responses

NameDescriptionExample
id사용량 정책 ID27bb070b564349f8a31cc60734cc36a5
api_keysAPI Key[]
created_at생성 일시
created_by_id생성자27bb070b564349f8a31cc60734cc36a5
created_by_name생성자username
description설명description
limit사용량 정책 할당량10
modified_at수정시간
modified_by_id수정자27bb070b564349f8a31cc60734cc36a5
modified_by_name수정자username
name이름usage-plan-name
rate사용량 정책 주기day