将 DeleteRestApi 与 AWS SDK 或 CLI 配合使用 - AWS SDK 代码示例

AWS 文档 SDK 示例 GitHub 存储库中还有更多 AWS SDK 示例。

将 DeleteRestApi 与 AWS SDK 或 CLI 配合使用

以下代码示例演示如何使用 DeleteRestApi。

操作示例是大型程序的代码摘录，必须在上下文中运行。在以下代码示例中，您可以查看此操作的上下文：

CLI
AWS CLI

删除 API

命令:

aws apigateway delete-rest-api --rest-api-id 1234123412

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 DeleteRestApi。

Java
适用于 Java 的 SDK 2.x
注意

查看 GitHub，了解更多信息。在 AWS 代码示例存储库中查找完整示例，了解如何进行设置和运行。

    public static void deleteAPI(ApiGatewayClient apiGateway, String restApiId) {

        try {
            DeleteRestApiRequest request = DeleteRestApiRequest.builder()
                    .restApiId(restApiId)
                    .build();

            apiGateway.deleteRestApi(request);
            System.out.println("The API was successfully deleted");

        } catch (ApiGatewayException e) {
            System.err.println(e.awsErrorDetails().errorMessage());
            System.exit(1);
        }
    }

  • 有关 API 详细信息，请参阅《AWS SDK for Java 2.x API Reference》中的 DeleteRestApi。

Python
适用于 Python 的 SDK (Boto3)
注意

查看 GitHub，了解更多信息。在 AWS 代码示例存储库中查找完整示例，了解如何进行设置和运行。

class ApiGatewayToService:
    """
    Encapsulates Amazon API Gateway functions that are used to create a REST API that
    integrates with another AWS service.
    """

    def __init__(self, apig_client):
        """
        :param apig_client: A Boto3 API Gateway client.
        """
        self.apig_client = apig_client
        self.api_id = None
        self.root_id = None
        self.stage = None


    def delete_rest_api(self):
        """
        Deletes a REST API, including all of its resources and configuration.
        """
        try:
            self.apig_client.delete_rest_api(restApiId=self.api_id)
            logger.info("Deleted REST API %s.", self.api_id)
            self.api_id = None
        except ClientError:
            logger.exception("Couldn't delete REST API %s.", self.api_id)
            raise

  • 有关 API 详细信息，请参阅《AWS SDK for Python (Boto3) API Reference》中的 DeleteRestApi。