API Gateway

Overview

Provides a Command-line Interface (CLI) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of API Gateway service and how to call CLI.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

CLI Version History

1.3

The Resource‑Policy feature has been added.
The response of the List Resources command has been changed.
The response of the Get Resource command has been changed.
The response of the List Methods command has been changed.
The request of the Create Method command has been changed.
The request of the Set Method command has been changed.
The response of the Get Method command has been changed.
The response of the List Stages command has been changed.
The response of the Get Stage command has been changed.

CLI Changes

• [New] application-apigateway resource policy show --api_id <value> - Show Resource Policy command has been added.
• [New] application-apigateway resource policy set --api_id <value> --version <value> --statement <value> - Set Resource Policy command has been added.
• [New] application-apigateway resource policy delete --api_id <value> - Delete Resource Policy command has been added.
• [Updated] application-apigateway resource list --api_id <value> - The following field has been added to the response.
  • iam_enabled
• [Updated] application-apigateway resource show --resource_id <value> --api_id <value> - The following field has been added to the response.
  • iam_enabled
• [Updated] application-apigateway method list --resource_id <value> --api_id <value> - The following field has been added to the response.
  • iam_enabled
• [Updated] application-apigateway method create --resource_id <value> --api_id <value> --method_type <value> --integration_type <value> - The following field has been added to the request.
  • iam_enabled
• [Updated] 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> - The following field has been added to the request.
  • iam_enabled
• [Updated] application-apigateway method show --method_type <value> --resource_id <value> --api_id <value> - The following field has been added to the response.
  • iam_enabled
• [Updated] application-apigateway stage list --api_id <value> - The following field has been added to the response.
  • description
  • api_key_required
  • usage_plan_name
  • uesage_plan_id
  • usage_plan_rate
  • usage_plan_limit
  • usage_plan_api_keys
• [Updated] application-apigateway stage list --api_id <value> - The following field has been removed to the response..
  • api_key_required
• [Updated] application-apigateway stage list --api_id <value> - The following field has been changed to the response.
  • Before "methods": [{"type": GET", "api_key_required": true}]
  • After "methods": [{"type": GET", "api_key_required": true, "iam_enabled": true}]
• [Updated] application-apigateway stage show --api_id <value> --stage_name <value> - The following field has been removed to the response.
  • api_key_required

1.2

The PrivateLink feature has been added.
The response of the List APIs command has been changed.
The request of the Create APi command has been changed.
The response of the Get APi command has been changed.
The response of the List Resources command has been changed.
The response of the Get Resource command has been changed.
The response of the List Methods command has been changed.
The request of the Create Method command has been changed.
The request of the Set Method command has been changed.
The response of the Get Method command has been changed.

CLI Changes

• [New] application-apigateway api connected endpoint list --api_id <value> - List Connected PrivateLink Endpoints command has been added.
• [New] application-apigateway privatelink endpoint list - List PrivateLink Endpoints command has been added.
• [New] application-apigateway privatelink endpoint create --privatelink_service_id <value> --name <value> - Create PrivateLink Endpoint command has been added.
• [New] application-apigateway privatelink endpoint delete --privatelink_endpoint_id <value> - Delete PrivateLink Endpoint command has been added.
• [New] application-apigateway privatelink endpoint set --privatelink_endpoint_id <value> - Set PrivateLink Endpoint command has been added.
• [New] application-apigateway privatelink endpoint approve --privatelink_endpoint_id <value> --type <value> --api_id <value> - Approve PrivateLink Endpoint command has been added.
• [New] application-apigateway privatelink endpoint connect --privatelink_endpoint_id <value> --type <value> --api_id <value> - Connect PrivateLink Endpoint command has been added.
• [New] application-apigateway privatelink endpoint request --privatelink_endpoint_id <value> --type <value> - Request PrivateLink Endpoint command has been added.
• [New] application-apigateway privatelink endpoint show --privatelink_endpoint_id <value> - Show PrivateLink Endpoint command has been added.
• [Updated] application-apigateway api list - The following field has been added to the response.
  • endpoint_type
• [Updated] application-apigateway api create --name <value> - The following field has been added to the request.
  • endpoint_type
• [Updated] application-apigateway api show --api_id <value> - The following field has been added to the response.
  • endpoint_type
  • privatelink_service_id
• [Updated] application-apigateway resource list --api_id <value> - The following field has been added to the response.
  • privatelink_endpoint_id
• [Updated] application-apigateway resource show --resource_id <value> --api_id <value> - The following field has been added to the response.
  • privatelink_endpoint_id
• [Updated] application-apigateway method list --resource_id <value> --api_id <value> - The following field has been added to the response.
  • privatelink_endpoint_id
• [Updated] application-apigateway method create --resource_id <value> --api_id <value> --method_type <value> --integration_type <value> - The following field has been added to the request.
  • privatelink_endpoint_id
• [Updated] 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> - The following field has been added to the request.
  • privatelink_endpoint_id
• [Updated] application-apigateway method show --method_type <value> --resource_id <value> --api_id <value> - The following field has been added to the response.
  • privatelink_endpoint_id

1.1

The Usage‑Policy feature has been added.
The API‑Key Management feature has been added.
The Report feature has been added.
The response of the List Resources command has been changed.
The response of the Get Resource command has been changed.
The response of the List Methods command has been changed.
The request of the Create Method command has been changed.
The request of the Set Method command has been changed.
The response of the Get Method command has been changed.
The response of the List Stages command has been changed.
The request of the Set Stage Configuration command has been changed.
The response of the Get Stage command has been changed.

CLI Changes

• [New] application-apigateway usage plan list --api_id <value> - List Usage Plans command has been added.
• [New] application-apigateway usage plan create --api_id <value> --rate <value> --name <value> --limit <value> - Create Usage Plan command has been added.
• [New] application-apigateway usage plan set description --usage_plan_id <value> --api_id <value> - Set Usage Plan Description command has been added.
• [New] application-apigateway usage plan set quota --usage_plan_id <value> --api_id <value> --rate <value> --limit <value> - Set Usage Plan Quota command has been added.
• [New] application-apigateway usage plan delete --usage_plan_id <value> --api_id <value> - Delete Usage Plan command has been added.
• [New] application-apigateway usage plan show --usage_plan_id <value> --api_id <value> - Show Usage Plan command has been added.
• [New] application-apigateway api key list --usage_plan_id <value> --api_id <value> - List Api Keys command has been added.
• [New] application-apigateway api key create --usage_plan_id <value> --api_id <value> --name <value> - Create APi Key command has been added.
• [New] application-apigateway api key set --api_key_id <value> --usage_plan_id <value> --api_id <value> - Set Api Key Description command has been added.
• [New] application-apigateway api key delete --api_key_id <value> --usage_plan_id <value> --api_id <value> - Delete Api Key command has been added.
• [New] application-apigateway report list --api_id <value> --end_date <value> --start_date <value> --stage_name <value> - List Reports command has been added.
• [Updated] application-apigateway resource list --api_id <value> - The following field has been added to the response.
  • function_name
  • api_key_required
• [Updated] application-apigateway resource show --resource_id <value> --api_id <value> - The following field has been added to the response.
  • function_name
  • api_key_required
• [Updated] application-apigateway method list --resource_id <value> --api_id <value> - The following field has been added to the response.
  • function_name
  • api_key_required
• [Updated] application-apigateway method create --resource_id <value> --api_id <value> --method_type <value> --integration_type <value> - The following field has been added to the request.
  • api_key_required
• [Updated] 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> - The following field has been added to the request.
  • api_key_required
  • endpoint_url
  • function_id
  • integration_type
• [Updated] application-apigateway method show --method_type <value> --resource_id <value> --api_id <value> - The following field has been added to the response.
  • function_name
  • api_key_required
• [Updated] application-apigateway stage list --api_id <value> - The following field has been added to the response.
  • description
  • api_key_required
  • usage_plan_name
  • uesage_plan_id
  • usage_plan_rate
  • usage_plan_limit
  • usage_plan_api_keys
• [Updated] application-apigateway stage list --api_id <value> - The following field has been removed to the response.
  • ip_restriction_enabled
• [Updated] application-apigateway stage list --api_id <value> - The following field has been changed to the response.
  • Before "methods": ["GET", "POST"]
  • After "methods": [{"type": GET", "api_key_required": true}]
• [Updated] application-apigateway stage set configuration --api_id <value> --stage_name <value> --jwt_enabled <value> --cors_enabled <value> - The following field has been added to the request.
  • description
  • usage_plan_id
  • connected_api_keys
• [Updated] application-apigateway stage set configuration --api_id <value> --stage_name <value> --jwt_enabled <value> --cors_enabled <value> - The following field has been removed to the request.
  • ip_restriction_enabled
• [Updated] application-apigateway stage show --api_id <value> --stage_name <value> - The following field has been added to the response.
  • description
  • api_key_required
  • usage_plan_name
  • uesage_plan_id
  • usage_plan_rate
  • usage_plan_limit
  • usage_plan_api_keys
• [Updated] application-apigateway stage show --api_id <value> --stage_name <value> - The following field has been removed to the response.
  • ip_restriction_enabled

1.0

Initial CLI release for API Gateway.

CLI Changes

• [New] application-apigateway api list - List APis command has been added.
• [New] application-apigateway api create --name <value> - Create Api command has been added.
• [New] application-apigateway api description set --api_id <value> - Set Api Description command has been added.
• [New] application-apigateway api delete --api_id <value> - Delete Api command has been added.
• [New] application-apigateway api show --api_id <value> - Show Api command has been added.
• [New] application-apigateway api deployment list --api_id <value> - List Api Deployments command has been added.
• [New] application-apigateway api deploy --api_id <value> --stage_type <value> - Create Api Deployment command has been added.
• [New] application-apigateway resource list --api_id <value> - List Resources command has been added.
• [New] application-apigateway resource create --parent_id <value> --api_id <value> --path_part <value> - Create Resource command has been added.
• [New] application-apigateway resource delete --resource_id <value> --api_id <value> - Delete Resource command has been added.
• [New] application-apigateway resource show --resource_id <value> --api_id <value> - Show Resource command has been added.
• [New] application-apigateway method list --resource_id <value> --api_id <value> - List Methods command has been added.
• [New] application-apigateway method create --resource_id <value> --api_id <value> --method_type <value> --integration_type <value> - Create Method command has been added.
• [New] 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 command has been added.
• [New] application-apigateway method delete --method_type <value> --resource_id <value> --api_id <value> - Delete Method command has been added.
• [New] application-apigateway method show --method_type <value> --resource_id <value> --api_id <value> - Show Method command has been added.
• [New] application-apigateway stage list --api_id <value> - List Stages command has been added.
• [New] application-apigateway stage create --api_id <value> --stage_name <value> --deployment_id <value> - Create Stage command has been added.
• [New] application-apigateway stage delete --api_id <value> --stage_name <value> - Delete Stage command has been added.
• [New] application-apigateway stage show --api_id <value> --stage_name <value> - Show Stage command has been added.
• [New] application-apigateway stage set active deployment --api_id <value> --stage_name <value> --deployment_id <value> - Set Stage Active Deployment command has been added.
• [New] application-apigateway stage set configuration --api_id <value> --stage_name <value> --jwt_enabled <value> --cors_enabled <value> - Set Stage Configuration command has been added.
• [New] application-apigateway auth list --api_id <value> - List Auths command has been added.
• [New] application-apigateway auth create --api_id <value> --name <value> --expiration_period <value> --connected_stages <value> - Create Auth command has been added.
• [New] application-apigateway auth set --auth_id <value> --api_id <value> --connected_stages <value> - Set Auth command has been added.
• [New] application-apigateway auth delete --auth_id <value> --api_id <value> - Delete Auth command has been added.
• [New] application-apigateway auth show --auth_id <value> --api_id <value> - Show Auth command has been added.
• [New] application-apigateway access control list --api_id <value> - List AccessControls command has been added.
• [New] application-apigateway access control create --api_id <value> --name <value> --connected_stages <value> --allowed_ip_addr <value> - Create AccessControl command has been added.
• [New] application-apigateway access control set --access_control_id <value> --api_id <value> --connected_stages <value> --allowed_ip_addr <value> - Set AccessControl command has been added.
• [New] application-apigateway access control delete --access_control_id <value> --api_id <value> - Delete AccessControl command has been added.
• [New] application-apigateway access control show --access_control_id <value> --api_id <value> - Show AccessControl command has been added.