使用的 API Gateway 範例 AWS CLI

下列程式碼範例示範如何使用 AWS Command Line Interface 搭配 API Gateway 執行動作和實作常見案例。

Actions 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會示範如何呼叫個別服務函數，但您可以在其相關案例中查看內容中的動作。

每個範例都包含完整原始程式碼的連結，您可以在其中找到如何在內容中設定和執行程式碼的指示。

主題

動作

動作

下列程式碼範例示範如何使用 create-api-key。

AWS CLI

建立為現有 API 和 Stage 啟用的 API 金鑰

命令：


aws apigateway create-api-key --name 'Dev API Key' --description 'Used for development' --enabled --stage-keys restApiId='a1b2c3d4e5',stageName='dev'

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateApiKey。

下列程式碼範例示範如何使用 create-authorizer。

AWS CLI

範例 1：為 API 建立以字符為基礎的 API Gateway Custom Authorizer

下列create-authorizer範例會建立以權杖為基礎的授權方。


aws apigateway create-authorizer \
    --rest-api-id 1234123412 \
    --name 'First_Token_Custom_Authorizer' \
    --type TOKEN \
    --authorizer-uri 'arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthFunction/invocations' \
    --identity-source 'method.request.header.Authorization' \
    --authorizer-result-ttl-in-seconds 300

輸出：


{
    "authType": "custom",
    "name": "First_Token_Custom_Authorizer",
    "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthFunction/invocations",
    "authorizerResultTtlInSeconds": 300,
    "identitySource": "method.request.header.Authorization",
    "type": "TOKEN",
    "id": "z40xj0"
}

範例 2：建立以 Cognito 使用者集區為基礎的 API Gateway Custom Authorizer for the API

下列create-authorizer範例會建立以 Cognito 使用者集區為基礎的 API Gateway Custom Authorizer。


aws apigateway create-authorizer \
    --rest-api-id 1234123412 \
    --name 'First_Cognito_Custom_Authorizer' \
    --type COGNITO_USER_POOLS \
    --provider-arns 'arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_aWcZeQbuD' \
    --identity-source 'method.request.header.Authorization'

輸出：


{
    "authType": "cognito_user_pools",
    "identitySource": "method.request.header.Authorization",
    "name": "First_Cognito_Custom_Authorizer",
    "providerARNs": [
        "arn:aws:cognito-idp:us-east-1:342398297714:userpool/us-east-1_qWbZzQhzE"
    ],
    "type": "COGNITO_USER_POOLS",
    "id": "5yid1t"
}

範例 3：為 API 建立以請求為基礎的 API Gateway 自訂授權方

下列create-authorizer範例會建立以請求為基礎的授權方。


aws apigateway create-authorizer \
    --rest-api-id 1234123412 \
    --name 'First_Request_Custom_Authorizer' \
    --type REQUEST \
    --authorizer-uri 'arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthFunction/invocations' \
    --identity-source 'method.request.header.Authorization,context.accountId' \
    --authorizer-result-ttl-in-seconds 300

輸出：


{
    "id": "z40xj0",
    "name": "First_Request_Custom_Authorizer",
    "type": "REQUEST",
    "authType": "custom",
    "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthFunction/invocations",
    "identitySource": "method.request.header.Authorization,context.accountId",
    "authorizerResultTtlInSeconds": 300
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateAuthorizer。

下列程式碼範例示範如何使用 create-base-path-mapping。

AWS CLI

為自訂網域名稱建立基本路徑映射

命令：


aws apigateway create-base-path-mapping --domain-name subdomain.domain.tld --rest-api-id 1234123412 --stage prod --base-path v1

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateBasePathMapping。

下列程式碼範例示範如何使用 create-deployment。

AWS CLI

將 API 的已設定資源部署到新的階段

命令：


aws apigateway create-deployment --rest-api-id 1234123412 --stage-name dev --stage-description 'Development Stage' --description 'First deployment to the dev stage'

將 API 的已設定資源部署至現有階段

命令：


aws apigateway create-deployment --rest-api-id 1234123412 --stage-name dev --description 'Second deployment to the dev stage'

將 API 的已設定資源部署至具有階段變數的現有階段

aws apigateway create-deployment --rest-api-id 1234123412 --stage-name dev --description 'Third deployment to the dev stage' --variables key='value'，otherKey='otherValue'

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateDeployment。

下列程式碼範例示範如何使用 create-domain-name。

AWS CLI

建立自訂網域名稱

命令：


aws apigateway create-domain-name --domain-name 'my.domain.tld' --certificate-name 'my.domain.tld cert' --certificate-arn 'arn:aws:acm:us-east-1:012345678910:certificate/fb1b9770-a305-495d-aefb-27e5e101ff3'

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateDomainName。

下列程式碼範例示範如何使用 create-model。

AWS CLI

若要建立 API 的模型

命令：


aws apigateway create-model --rest-api-id 1234123412 --name 'firstModel' --description 'The First Model' --content-type 'application/json'  --schema '{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "firstModel", "type": "object", "properties": { "firstProperty" : { "type": "object", "properties": { "key": { "type": "string" } } } } }'

輸出：


{
    "contentType": "application/json",
    "description": "The First Model",
    "name": "firstModel",
    "id": "2rzg0l",
    "schema": "{ \"$schema\": \"http://json-schema.org/draft-04/schema#\", \"title\": \"firstModel\", \"type\": \"object\", \"properties\": { \"firstProperty\" : { \"type\": \"object\", \"properties\": { \"key\": { \"type\": \"string\" } } } } }"
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateModel。

下列程式碼範例示範如何使用 create-resource。

AWS CLI

在 API 中建立資源

命令：


aws apigateway create-resource --rest-api-id 1234123412 --parent-id a1b2c3 --path-part 'new-resource'

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateResource。

下列程式碼範例示範如何使用 create-rest-api。

AWS CLI

若要建立 API

命令：


aws apigateway create-rest-api --name 'My First API' --description 'This is my first API'

從現有 API 建立重複的 API

命令：


aws apigateway create-rest-api --name 'Copy of My First API' --description 'This is a copy of my first API' --clone-from 1234123412

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateRestApi。

下列程式碼範例示範如何使用 create-stage。

AWS CLI

在包含現有部署的 API 中建立階段

命令：


aws apigateway create-stage --rest-api-id 1234123412 --stage-name 'dev' --description 'Development stage' --deployment-id a1b2c3

在包含現有部署和自訂階段變數的 API 中建立階段

命令：


aws apigateway create-stage --rest-api-id 1234123412 --stage-name 'dev' --description 'Development stage' --deployment-id a1b2c3 --variables key='value',otherKey='otherValue'

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateStage。

下列程式碼範例示範如何使用 create-usage-plan-key。

AWS CLI

將現有的 API 金鑰與 Usage Plan 建立關聯

命令：


aws apigateway create-usage-plan-key --usage-plan-id a1b2c3 --key-type "API_KEY" --key-id 4vq3yryqm5

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateUsagePlanKey。

下列程式碼範例示範如何使用 create-usage-plan。

AWS CLI

建立使用計畫，其中限流和配額限制會在當月開始時重設

命令：


aws apigateway create-usage-plan --name "New Usage Plan" --description "A new usage plan" --throttle burstLimit=10,rateLimit=5 --quota limit=500,offset=0,period=MONTH

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateUsagePlan。

下列程式碼範例示範如何使用 delete-api-key。

AWS CLI

若要刪除 API 金鑰

命令：


aws apigateway delete-api-key --api-key 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteApiKey。

下列程式碼範例示範如何使用 delete-authorizer。

AWS CLI

在 API 中刪除自訂授權方

命令：


aws apigateway delete-authorizer --rest-api-id 1234123412 --authorizer-id 7gkfbo

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteAuthorizer。

下列程式碼範例示範如何使用 delete-base-path-mapping。

AWS CLI

刪除自訂網域名稱的基本路徑映射

命令：


aws apigateway delete-base-path-mapping --domain-name 'api.domain.tld' --base-path 'dev'

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteBasePathMapping。

下列程式碼範例示範如何使用 delete-client-certificate。

AWS CLI

若要刪除用戶端憑證

命令：


aws apigateway delete-client-certificate --client-certificate-id a1b2c3

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteClientCertificate。

下列程式碼範例示範如何使用 delete-deployment。

AWS CLI

若要刪除 API 中的部署

命令：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteDeployment。

下列程式碼範例示範如何使用 delete-domain-name。

AWS CLI

若要刪除自訂網域名稱

命令：


aws apigateway delete-domain-name --domain-name 'api.domain.tld'

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteDomainName。

下列程式碼範例示範如何使用 delete-integration-response。

AWS CLI

若要刪除 API 中指定資源、方法和狀態碼的整合回應

命令：


aws apigateway delete-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteIntegrationResponse。

下列程式碼範例示範如何使用 delete-integration。

AWS CLI

在 API 中刪除指定資源和方法的整合

命令：


aws apigateway delete-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteIntegration。

下列程式碼範例示範如何使用 delete-method-response。

AWS CLI

若要刪除 API 中指定資源、方法和狀態碼的方法回應

命令：


aws apigateway delete-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteMethodResponse。

下列程式碼範例示範如何使用 delete-method。

AWS CLI

若要刪除 API 中指定資源的方法

命令：


aws apigateway delete-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteMethod。

下列程式碼範例示範如何使用 delete-model。

AWS CLI

若要刪除指定 API 中的模型

命令：


aws apigateway delete-model --rest-api-id 1234123412 --model-name 'customModel'

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteModel。

下列程式碼範例示範如何使用 delete-resource。

AWS CLI

若要刪除 API 中的資源

命令：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteResource。

下列程式碼範例示範如何使用 delete-rest-api。

AWS CLI

若要刪除 API

命令：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteRestApi。

下列程式碼範例示範如何使用 delete-stage。

AWS CLI

若要刪除 API 中的階段

命令：


aws apigateway delete-stage --rest-api-id 1234123412 --stage-name 'dev'

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteStage。

下列程式碼範例示範如何使用 delete-usage-plan-key。

AWS CLI

從用量計劃中移除 API 金鑰

命令：


aws apigateway delete-usage-plan-key --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteUsagePlanKey。

下列程式碼範例示範如何使用 delete-usage-plan。

AWS CLI

刪除用量計劃

命令：


aws apigateway delete-usage-plan --usage-plan-id a1b2c3

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteUsagePlan。

下列程式碼範例示範如何使用 flush-stage-authorizers-cache。

AWS CLI

若要排清階段上的所有授權方快取項目

命令：


aws apigateway flush-stage-authorizers-cache --rest-api-id 1234123412 --stage-name dev

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 FlushStageAuthorizersCache。

下列程式碼範例示範如何使用 flush-stage-cache。

AWS CLI

若要排清 API 階段的快取

命令：


aws apigateway flush-stage-cache --rest-api-id 1234123412 --stage-name dev

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 FlushStageCache。

下列程式碼範例示範如何使用 generate-client-certificate。

AWS CLI

建立用戶端 SSL 憑證

命令：


aws apigateway generate-client-certificate --description 'My First Client Certificate'

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GenerateClientCertificate。

下列程式碼範例示範如何使用 get-account。

AWS CLI

若要取得 API Gateway 帳戶設定

命令：


aws apigateway get-account

輸出：


{
    "cloudwatchRoleArn": "arn:aws:iam::123412341234:role/APIGatewayToCloudWatchLogsRole",
    "throttleSettings": {
        "rateLimit": 500.0,
        "burstLimit": 1000
    }
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetAccount。

下列程式碼範例示範如何使用 get-api-key。

AWS CLI

取得特定 API 金鑰的相關資訊

命令：


aws apigateway get-api-key --api-key 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk

輸出：


{
    "description": "My first key",
    "enabled": true,
    "stageKeys": [
        "a1b2c3d4e5/dev",
        "e5d4c3b2a1/dev"
    ],
    "lastUpdatedDate": 1456184515,
    "createdDate": 1456184452,
    "id": "8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk",
    "name": "My key"
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetApiKey。

下列程式碼範例示範如何使用 get-api-keys。

AWS CLI

若要取得 API 金鑰清單

命令：


aws apigateway get-api-keys

輸出：


{
    "items": [
        {
            "description": "My first key",
            "enabled": true,
            "stageKeys": [
                "a1b2c3d4e5/dev",
                "e5d4c3b2a1/dev"
            ],
            "lastUpdatedDate": 1456184515,
            "createdDate": 1456184452,
            "id": "8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk",
            "name": "My key"
        }
    ]
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetApiKeys。

下列程式碼範例示範如何使用 get-authorizer。

AWS CLI

若要取得 API Gateway per-API 授權方設定

命令：


aws apigateway get-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3

輸出：


{
    "authorizerResultTtlInSeconds": 300,
    "name": "MyAuthorizer",
    "type": "TOKEN",
    "identitySource": "method.request.header.Authorization",
    "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:authorizer_function/invocations",
    "id": "gfi4n3"
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetAuthorizer。

下列程式碼範例示範如何使用 get-authorizers。

AWS CLI

若要取得 REST 的授權方清單 API

命令：


aws apigateway get-authorizers --rest-api-id 1234123412

輸出：


{
    "items": [
        {
            "name": "MyAuthorizer",
            "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:My_Authorizer_Function/invocations",
            "authorizerResultTtlInSeconds": 300,
            "identitySource": "method.request.header.Authorization",
            "type": "TOKEN",
            "id": "gfi4n3"
        }
    ]
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetAuthorizers。

下列程式碼範例示範如何使用 get-base-path-mapping。

AWS CLI

取得自訂網域名稱的基本路徑映射

命令：


aws apigateway get-base-path-mapping --domain-name subdomain.domain.tld --base-path v1

輸出：


{
    "basePath": "v1",
    "restApiId": "1234w4321e",
    "stage": "api"
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetBasePathMapping。

下列程式碼範例示範如何使用 get-base-path-mappings。

AWS CLI

取得自訂網域名稱的基本路徑映射

命令：


aws apigateway get-base-path-mappings --domain-name subdomain.domain.tld

輸出：


{
    "items": [
        {
            "basePath": "(none)",
            "restApiId": "1234w4321e",
            "stage": "dev"
        },
        {
            "basePath": "v1",
            "restApiId": "1234w4321e",
            "stage": "api"
        }
    ]
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetBasePathMappings。

下列程式碼範例示範如何使用 get-client-certificate。

AWS CLI

若要取得用戶端憑證

命令：


aws apigateway get-client-certificate --client-certificate-id a1b2c3

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetClientCertificate。

下列程式碼範例示範如何使用 get-client-certificates。

AWS CLI

若要取得用戶端憑證清單

命令：


aws apigateway get-client-certificates

輸出：


{
    "items": [
        {
            "pemEncodedCertificate": "-----BEGIN CERTIFICATE----- <certificate content> -----END CERTIFICATE-----",
            "clientCertificateId": "a1b2c3",
            "expirationDate": 1483556561,
            "description": "My Client Certificate",
            "createdDate": 1452020561
        }
    ]
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetClientCertificates。

下列程式碼範例示範如何使用 get-deployment。

AWS CLI

取得部署的相關資訊

命令：


aws apigateway get-deployment --rest-api-id 1234123412 --deployment-id ztt4m2

輸出：


{
    "description": "myDeployment",
    "id": "ztt4m2",
    "createdDate": 1455218022
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetDeployment。

下列程式碼範例示範如何使用 get-deployments。

AWS CLI

若要取得 REST 的部署清單 API

命令：


aws apigateway get-deployments --rest-api-id 1234123412

輸出：


{
    "items": [
        {
            "createdDate": 1453797217,
            "id": "0a2b4c",
            "description": "Deployed my API for the first time"
        }
    ]
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetDeployments。

下列程式碼範例示範如何使用 get-domain-name。

AWS CLI

若要取得自訂網域名稱的相關資訊

命令：


aws apigateway get-domain-name --domain-name api.domain.tld

輸出：


{
    "domainName": "api.domain.tld",
    "distributionDomainName": "d1a2f3a4c5o6d.cloudfront.net",
    "certificateName": "uploadedCertificate",
    "certificateUploadDate": 1462565487
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetDomainName。

下列程式碼範例示範如何使用 get-domain-names。

AWS CLI

若要取得自訂網域名稱的清單

命令：


aws apigateway get-domain-names

輸出：


{
    "items": [
        {
            "distributionDomainName": "d9511k3l09bkd.cloudfront.net",
            "certificateUploadDate": 1452812505,
            "certificateName": "my_custom_domain-certificate",
            "domainName": "subdomain.domain.tld"
        }
    ]
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetDomainNames。

下列程式碼範例示範如何使用 get-export。

AWS CLI

取得階段的 JSON Swagger 範本

命令：


aws apigateway get-export --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json

取得階段的 JSON Swagger 範本 + API Gateway Extentions

命令：


aws apigateway get-export --parameters extensions='integrations' --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json

取得階段的 JSON Swagger 範本 + Postman 擴充功能

命令：


aws apigateway get-export --parameters extensions='postman' --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetExport。

下列程式碼範例示範如何使用 get-integration-response。

AWS CLI

取得在 HTTP 的資源下定義的 REST 方法API的整合回應組態

命令：


aws apigateway get-integration-response --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET --status-code 200

輸出：


{
    "statusCode": "200",
    "responseTemplates": {
        "application/json": null
    }
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetIntegrationResponse。

下列程式碼範例示範如何使用 get-integration。

AWS CLI

取得在 HTTP 的資源下定義的 REST 方法API整合組態

命令：


aws apigateway get-integration --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET

輸出：


{
    "httpMethod": "POST",
    "integrationResponses": {
        "200": {
            "responseTemplates": {
                "application/json": null
            },
            "statusCode": "200"
        }
    },
    "cacheKeyParameters": [],
    "type": "AWS",
    "uri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:My_Function/invocations",
    "cacheNamespace": "y9h6rt"
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetIntegration。

下列程式碼範例示範如何使用 get-method-response。

AWS CLI

取得在 HTTP 的資源下定義的 REST 方法的方法回應API資源組態

命令：


aws apigateway get-method-response --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET --status-code 200

輸出：


{
    "responseModels": {
        "application/json": "Empty"
    },
    "statusCode": "200"
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetMethodResponse。

下列程式碼範例示範如何使用 get-method。

AWS CLI

取得 HTTP 方法在 REST 的資源下定義的方法API資源組態

命令：


aws apigateway get-method --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET

輸出：


{
    "apiKeyRequired": false,
    "httpMethod": "GET",
    "methodIntegration": {
        "integrationResponses": {
            "200": {
                "responseTemplates": {
                    "application/json": null
                },
                "statusCode": "200"
            }
        },
        "cacheKeyParameters": [],
        "uri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:My_Function/invocations",
        "httpMethod": "POST",
        "cacheNamespace": "y9h6rt",
        "type": "AWS"
    },
    "requestParameters": {},
    "methodResponses": {
        "200": {
            "responseModels": {
                "application/json": "Empty"
            },
            "statusCode": "200"
        }
    },
    "authorizationType": "NONE"
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetMethod。

下列程式碼範例示範如何使用 get-model-template。

AWS CLI

取得在 REST 下定義的模型的映射範本 API

命令：


aws apigateway get-model-template --rest-api-id 1234123412 --model-name Empty

輸出：


{
    "value": "#set($inputRoot = $input.path('$'))\n{ }"
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetModelTemplate。

下列程式碼範例示範如何使用 get-model。

AWS CLI

取得 REST 下定義的模型組態 API

命令：


aws apigateway get-model --rest-api-id 1234123412 --model-name Empty

輸出：


{
    "contentType": "application/json",
    "description": "This is a default empty schema model",
    "name": "Empty",
    "id": "etd5w5",
    "schema": "{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"title\" : \"Empty Schema\",\n  \"type\" : \"object\"\n}"
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetModel。

下列程式碼範例示範如何使用 get-models。

AWS CLI

若要取得 REST 的模型清單 API

命令：


aws apigateway get-models --rest-api-id 1234123412

輸出：


{
    "items": [
        {
            "description": "This is a default error schema model",
            "schema": "{\n  \"$schema\" : \"http://json-schema.org/draft-04/schema#\",\n  \"title\" : \"Error Schema\",\n  \"type\" : \"object\",\n  \"properties\" : {\n    \"message\" : { \"type\" : \"string\" }\n  }\n}",
            "contentType": "application/json",
            "id": "7tpbze",
            "name": "Error"
        },
        {
            "description": "This is a default empty schema model",
            "schema": "{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"title\" : \"Empty Schema\",\n  \"type\" : \"object\"\n}",
            "contentType": "application/json",
            "id": "etd5w5",
            "name": "Empty"
        }
    ]
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetModels。

下列程式碼範例示範如何使用 get-resource。

AWS CLI

若要取得資源的相關資訊

命令：


aws apigateway get-resource --rest-api-id 1234123412 --resource-id zwo0y3

輸出：


{
    "path": "/path",
    "pathPart": "path",
    "id": "zwo0y3",
    "parentId": "uyokt6ij2g"
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetResource。

下列程式碼範例示範如何使用 get-resources。

AWS CLI

取得 REST 的資源清單 API

命令：


aws apigateway get-resources --rest-api-id 1234123412

輸出：


{
    "items": [
        {
            "path": "/resource/subresource",
            "resourceMethods": {
                "POST": {}
            },
            "id": "024ace",
            "pathPart": "subresource",
            "parentId": "ai5b02"
        }
    ]
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetResources。

下列程式碼範例示範如何使用 get-rest-api。

AWS CLI

若要取得 API 的相關資訊

命令：


aws apigateway get-rest-api --rest-api-id 1234123412

輸出：


{
    "name": "myAPI",
    "id": "o1y243m4f5",
    "createdDate": 1453416433
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetRestApi。

下列程式碼範例示範如何使用 get-rest-apis。

AWS CLI

若要取得 REST 清單 APIs

命令：


aws apigateway get-rest-apis

輸出：


{
    "items": [
        {
            "createdDate": 1438884790,
            "id": "12s44z21rb",
            "name": "My First API"
        }
    ]
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetRestApis。

下列程式碼範例示範如何使用 get-sdk。

AWS CLI

取得 SDK 階段的 Android REST API

命令：


aws apigateway get-sdk --rest-api-id 1234123412 --stage-name dev --sdk-type android --parameters groupId='com.mycompany',invokerPackage='com.mycompany.clientsdk',artifactId='Mycompany-client',artifactVersion='1.0.0' /path/to/android_sdk.zip

輸出：


{
    "contentType": "application/octet-stream",
    "contentDisposition": "attachment; filename=\"android_2016-02-22_23-52Z.zip\""
}

取得 IOS SDK 階段的 REST API

命令：


aws apigateway get-sdk --rest-api-id 1234123412 --stage-name dev --sdk-type objectivec --parameters classPrefix='myprefix' /path/to/iOS_sdk.zip

輸出：


{
    "contentType": "application/octet-stream",
    "contentDisposition": "attachment; filename=\"objectivec_2016-02-22_23-52Z.zip\""
}

取得 SDK 階段的 Javascript REST API

命令：


aws apigateway get-sdk --rest-api-id 1234123412 --stage-name dev --sdk-type javascript /path/to/javascript_sdk.zip

輸出：


{
    "contentType": "application/octet-stream",
    "contentDisposition": "attachment; filename=\"javascript_2016-02-22_23-52Z.zip\""
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetSdk。

下列程式碼範例示範如何使用 get-stage。

AWS CLI

取得 API 階段的相關資訊

命令：


aws apigateway get-stage --rest-api-id 1234123412 --stage-name dev

輸出：


{
    "stageName": "dev",
    "cacheClusterSize": "0.5",
    "cacheClusterEnabled": false,
    "cacheClusterStatus": "NOT_AVAILABLE",
    "deploymentId": "rbh1fj",
    "lastUpdatedDate": 1466802961,
    "createdDate": 1460682074,
    "methodSettings": {
        "*/*": {
            "cacheTtlInSeconds": 300,
            "loggingLevel": "INFO",
            "dataTraceEnabled": false,
            "metricsEnabled": true,
            "unauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER",
            "throttlingRateLimit": 500.0,
            "cacheDataEncrypted": false,
            "cachingEnabled": false,
            "throttlingBurstLimit": 1000,
            "requireAuthorizationForCacheControl": true
        },
        "~1resource/GET": {
            "cacheTtlInSeconds": 300,
            "loggingLevel": "INFO",
            "dataTraceEnabled": false,
            "metricsEnabled": true,
            "unauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER",
            "throttlingRateLimit": 500.0,
            "cacheDataEncrypted": false,
            "cachingEnabled": false,
            "throttlingBurstLimit": 1000,
            "requireAuthorizationForCacheControl": true
        }
    }
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetStage。

下列程式碼範例示範如何使用 get-stages。

AWS CLI

若要取得 REST 的階段清單 API

命令：


aws apigateway get-stages --rest-api-id 1234123412

輸出：


{
    "item": [
        {
            "stageName": "dev",
            "cacheClusterSize": "0.5",
            "cacheClusterEnabled": true,
            "cacheClusterStatus": "AVAILABLE",
            "deploymentId": "123h64",
            "lastUpdatedDate": 1456185138,
            "createdDate": 1453589092,
            "methodSettings": {
                "~1resource~1subresource/POST": {
                    "cacheTtlInSeconds": 300,
                    "loggingLevel": "INFO",
                    "dataTraceEnabled": true,
                    "metricsEnabled": true,
                    "throttlingRateLimit": 500.0,
                    "cacheDataEncrypted": false,
                    "cachingEnabled": false,
                    "throttlingBurstLimit": 1000
                }
            }
        }
    ]
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetStages。

下列程式碼範例示範如何使用 get-usage-plan-key。

AWS CLI

若要取得與用量計劃相關聯的 API 金鑰詳細資訊

命令：


aws apigateway get-usage-plan-key --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetUsagePlanKey。

下列程式碼範例示範如何使用 get-usage-plan-keys。

AWS CLI

若要取得與用量計劃關聯的 API 金鑰清單

命令：


aws apigateway get-usage-plan-keys --usage-plan-id a1b2c3

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetUsagePlanKeys。

下列程式碼範例示範如何使用 get-usage-plan。

AWS CLI

若要取得用量計劃的詳細資訊

命令：


aws apigateway get-usage-plan --usage-plan-id a1b2c3

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetUsagePlan。

下列程式碼範例示範如何使用 get-usage-plans。

AWS CLI

取得所有用量計劃的詳細資訊

命令：


aws apigateway get-usage-plans

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetUsagePlans。

下列程式碼範例示範如何使用 get-usage。

AWS CLI

若要取得用量計畫的用量詳細資訊

命令：


aws apigateway get-usage --usage-plan-id a1b2c3 --start-date "2016-08-16" --end-date "2016-08-17"

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetUsage。

下列程式碼範例示範如何使用 import-rest-api。

AWS CLI

匯入 Swagger 範本並建立 API

命令：


aws apigateway import-rest-api --body 'file:///path/to/API_Swagger_template.json'

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 ImportRestApi。

下列程式碼範例示範如何使用 put-integration-response。

AWS CLI

建立整合回應作為預設回應，並定義映射範本

命令：


aws apigateway put-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --selection-pattern "" --response-templates '{"application/json": "{\"json\": \"template\"}"}'

建立 regex 為 400 且靜態定義標頭值的整合回應

命令：


aws apigateway put-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 400 --selection-pattern 400 --response-parameters '{"method.response.header.custom-header": "'"'"'custom-value'"'"'"}'

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 PutIntegrationResponse。

下列程式碼範例示範如何使用 put-integration。

AWS CLI

建立 MOCK 整合請求

命令：


aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type MOCK --request-templates '{ "application/json": "{\"statusCode\": 200}" }'

建立 HTTP 整合請求

命令：


aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type HTTP --integration-http-method GET --uri 'https://domain.tld/path'

建立與 Lambda Function 端點的 AWS 整合請求

命令：


aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type AWS --integration-http-method POST --uri 'arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:function_name/invocations'

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 PutIntegration。

下列程式碼範例示範如何使用 put-method-response。

AWS CLI

在具有自訂方法回應標頭的指定狀態碼下建立方法回應

命令：


aws apigateway put-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 400 --response-parameters "method.response.header.custom-header=false"

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 PutMethodResponse。

下列程式碼範例示範如何使用 put-method。

AWS CLI

在未經授權、無 API 金鑰和自訂方法請求標頭的 API 中為資源建立方法

命令：


aws apigateway put-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method PUT --authorization-type "NONE" --no-api-key-required --request-parameters "method.request.header.custom-header=false"

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 PutMethod。

下列程式碼範例示範如何使用 put-rest-api。

AWS CLI

使用 Swagger 範本覆寫現有 API

命令：


aws apigateway put-rest-api --rest-api-id 1234123412 --mode overwrite --body 'fileb:///path/to/API_Swagger_template.json'

將 Swagger 範本合併至現有的 API

命令：


aws apigateway put-rest-api --rest-api-id 1234123412 --mode merge --body 'fileb:///path/to/API_Swagger_template.json'

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 PutRestApi。

下列程式碼範例示範如何使用 test-invoke-authorizer。

AWS CLI

測試呼叫請求至自訂授權方，包括所需的標頭和值

命令：


aws apigateway test-invoke-authorizer --rest-api-id 1234123412 --authorizer-id 5yid1t --headers Authorization='Value'

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 TestInvokeAuthorizer。

下列程式碼範例示範如何使用 test-invoke-method。

AWS CLI

測試透過提出 API 請求來調用 GET 中的根資源

命令：


aws apigateway test-invoke-method --rest-api-id 1234123412 --resource-id avl5sg8fw8 --http-method GET --path-with-query-string '/'

使用指定的路徑參數值來提出 GET 請求，以測試在 API 中調用子資源

命令：


aws apigateway test-invoke-method --rest-api-id 1234123412 --resource-id 3gapai --http-method GET --path-with-query-string '/pets/1'

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 TestInvokeMethod。

下列程式碼範例示範如何使用 update-account。

AWS CLI

若要變更用於記錄至IAM Logs 的 CloudWatch 角色 ARN

命令：


aws apigateway update-account --patch-operations op='replace',path='/cloudwatchRoleArn',value='arn:aws:iam::123412341234:role/APIGatewayToCloudWatchLogs'

輸出：


{
    "cloudwatchRoleArn": "arn:aws:iam::123412341234:role/APIGatewayToCloudWatchLogs",
    "throttleSettings": {
        "rateLimit": 1000.0,
        "burstLimit": 2000
    }
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateAccount。

下列程式碼範例示範如何使用 update-api-key。

AWS CLI

變更 API 金鑰的名稱

命令：


aws apigateway update-api-key --api-key sNvjQDMReA1eEQPNAW8r37XsU2rDD7fc7m2SiMnu --patch-operations op='replace',path='/name',value='newName'

輸出：


{
    "description": "currentDescription",
    "enabled": true,
    "stageKeys": [
        "41t2j324r5/dev"
    ],
    "lastUpdatedDate": 1470086052,
    "createdDate": 1445460347,
    "id": "sNvjQDMReA1vEQPNzW8r3dXsU2rrD7fcjm2SiMnu",
    "name": "newName"
}

停用 API 金鑰

命令：


aws apigateway update-api-key --api-key sNvjQDMReA1eEQPNAW8r37XsU2rDD7fc7m2SiMnu --patch-operations op='replace',path='/enabled',value='false'

輸出：


{
    "description": "currentDescription",
    "enabled": false,
    "stageKeys": [
        "41t2j324r5/dev"
    ],
    "lastUpdatedDate": 1470086052,
    "createdDate": 1445460347,
    "id": "sNvjQDMReA1vEQPNzW8r3dXsU2rrD7fcjm2SiMnu",
    "name": "newName"
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateApiKey。

下列程式碼範例示範如何使用 update-authorizer。

AWS CLI

若要變更自訂授權方的名稱

命令：


aws apigateway update-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 --patch-operations op='replace',path='/name',value='testAuthorizer'

輸出：


{
    "authType": "custom",
    "name": "testAuthorizer",
    "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthorizer/invocations",
    "authorizerResultTtlInSeconds": 300,
    "identitySource": "method.request.header.Authorization",
    "type": "TOKEN",
    "id": "gfi4n3"
}

若要變更自訂授權方調用的 Lambda 函數

命令：


aws apigateway update-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 --patch-operations op='replace',path='/authorizerUri',value='arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:newAuthorizer/invocations'

輸出：


{
    "authType": "custom",
    "name": "testAuthorizer",
    "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:newAuthorizer/invocations",
    "authorizerResultTtlInSeconds": 300,
    "identitySource": "method.request.header.Authorization",
    "type": "TOKEN",
    "id": "gfi4n3"
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateAuthorizer。

下列程式碼範例示範如何使用 update-base-path-mapping。

AWS CLI

變更自訂網域名稱的基本路徑

命令：


aws apigateway update-base-path-mapping --domain-name api.domain.tld --base-path prod --patch-operations op='replace',path='/basePath',value='v1'

輸出：


{
    "basePath": "v1",
    "restApiId": "1234123412",
    "stage": "api"
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateBasePathMapping。

下列程式碼範例示範如何使用 update-client-certificate。

AWS CLI

更新用戶端憑證的說明

命令：


aws apigateway update-client-certificate --client-certificate-id a1b2c3 --patch-operations op='replace',path='/description',value='My new description'

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateClientCertificate。

下列程式碼範例示範如何使用 update-deployment。

AWS CLI

若要變更部署的描述

命令：


aws apigateway update-deployment --rest-api-id 1234123412 --deployment-id ztt4m2 --patch-operations op='replace',path='/description',value='newDescription'

輸出：


{
    "description": "newDescription",
    "id": "ztt4m2",
    "createdDate": 1455218022
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateDeployment。

下列程式碼範例示範如何使用 update-domain-name。

AWS CLI

若要變更自訂網域名稱的憑證名稱

下列update-domain-name範例會變更自訂網域的憑證名稱。


aws apigateway update-domain-name \
    --domain-name api.domain.tld \
    --patch-operations op='replace',path='/certificateArn',value='arn:aws:acm:us-west-2:111122223333:certificate/CERTEXAMPLE123EXAMPLE'

輸出：


{
    "domainName": "api.domain.tld",
    "distributionDomainName": "d123456789012.cloudfront.net",
    "certificateArn": "arn:aws:acm:us-west-2:111122223333:certificate/CERTEXAMPLE123EXAMPLE",
    "certificateUploadDate": 1462565487
}

如需詳細資訊，請參閱 Amazon API Gateway 開發人員指南中的在 API Gateway 中設定 Word 的自訂網域名稱。 API

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateDomainName。

下列程式碼範例示範如何使用 update-integration-response。

AWS CLI

若要將整合回應標頭變更為具有 '*' 的靜態映射

命令：


aws apigateway update-integration-response --rest-api-id 1234123412 --resource-id 3gapai --http-method GET --status-code 200 --patch-operations op='replace',path='/responseParameters/method.response.header.Access-Control-Allow-Origin',value='"'"'*'"'"'

輸出：


{
    "statusCode": "200",
    "responseParameters": {
        "method.response.header.Access-Control-Allow-Origin": "'*'"
    }
}

若要移除整合回應標頭

命令：


aws apigateway update-integration-response --rest-api-id 1234123412 --resource-id 3gapai --http-method GET --status-code 200 --patch-operations op='remove',path='/responseParameters/method.response.header.Access-Control-Allow-Origin'

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateIntegrationResponse。

下列程式碼範例示範如何使用 update-integration。

AWS CLI

若要新增以 Input Passthrough 設定的「內容類型：Application/json」映射範本

命令：


aws apigateway update-integration \
    --rest-api-id a1b2c3d4e5 \
    --resource-id a1b2c3 \
    --http-method POST \
    --patch-operations "op='add',path='/requestTemplates/application~1json'"

更新（取代）以自訂範本設定的「內容類型：Application/json」映射範本

命令：


aws apigateway update-integration \
    --rest-api-id a1b2c3d4e5 \
    --resource-id a1b2c3 \
    --http-method POST \
    --patch-operations "op='replace',path='/requestTemplates/application~1json',value='{"example": "json"}'"

使用輸入傳遞更新（取代）與 'Content-Type： Application/json' 相關聯的自訂範本

命令：


aws apigateway update-integration \
    --rest-api-id a1b2c3d4e5 \
    --resource-id a1b2c3 \
    --http-method POST \
    --patch-operations "op='replace',path='requestTemplates/application~1json'"

若要移除 'Content-Type：application/json' 映射範本

命令：


aws apigateway update-integration \
    --rest-api-id a1b2c3d4e5 \
    --resource-id a1b2c3 \
    --http-method POST \
    --patch-operations "op='remove',path='/requestTemplates/application~1json'"

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateIntegration。

下列程式碼範例示範如何使用 update-method-response。

AWS CLI

在方法中為 200 個回應建立新的方法回應標頭，並將其定義為不需要（預設）

命令：


aws apigateway update-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --patch-operations op="add",path="/responseParameters/method.response.header.custom-header",value="false"

在方法中刪除 200 回應的回應模型

命令：


aws apigateway update-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --patch-operations op="remove",path="/responseModels/application~1json"

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateMethodResponse。

下列程式碼範例示範如何使用 update-method。

AWS CLI

範例 1：修改方法以要求 API 金鑰

下列update-method範例會修改方法，以要求 API 金鑰。


aws apigateway update-method \
    --rest-api-id 1234123412 \
    --resource-id a1b2c3 \
    --http-method GET \
    --patch-operations op="replace",path="/apiKeyRequired",value="true"

輸出：


{
    "httpMethod": "GET",
    "authorizationType": "NONE",
    "apiKeyRequired": true,
    "methodResponses": {
        "200": {
            "statusCode": "200",
            "responseModels": {}
        }
    },
    "methodIntegration": {
        "type": "AWS",
        "httpMethod": "POST",
        "uri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789111:function:hello-world/invocations",
        "passthroughBehavior": "WHEN_NO_MATCH",
        "contentHandling": "CONVERT_TO_TEXT",
        "timeoutInMillis": 29000,
        "cacheNamespace": "h7i8j9",
        "cacheKeyParameters": [],
        "integrationResponses": {
            "200": {
                "statusCode": "200",
                "responseTemplates": {}
            }
        }
    }
}

範例 2：修改方法以要求 IAM 授權

下列update-method範例會將方法修改為需要 IAM 授權。


aws apigateway update-method \
    --rest-api-id 1234123412 \
    --resource-id a1b2c3 \
    --http-method GET \
    --patch-operations op="replace",path="/authorizationType",value="AWS_IAM"

輸出：


 {
    "httpMethod": "GET",
    "authorizationType": "AWS_IAM",
    "apiKeyRequired": false,
    "methodResponses": {
        "200": {
            "statusCode": "200",
            "responseModels": {}
        }
    },
    "methodIntegration": {
        "type": "AWS",
        "httpMethod": "POST",
        "uri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789111:function:hello-world/invocations",
        "passthroughBehavior": "WHEN_NO_MATCH",
        "contentHandling": "CONVERT_TO_TEXT",
        "timeoutInMillis": 29000,
        "cacheNamespace": "h7i8j9",
        "cacheKeyParameters": [],
        "integrationResponses": {
            "200": {
                "statusCode": "200",
                "responseTemplates": {}
            }
        }
    }
}

範例 3：修改方法以要求 Lambda 授權

下列update-method範例會將方法修改為所需的 Lambda 授權。


aws apigateway update-method --rest-api-id 1234123412 \
    --resource-id a1b2c3 \
    --http-method GET \
    --patch-operations op="replace",path="/authorizationType",value="CUSTOM" op="replace",path="/authorizerId",value="e4f5g6"

輸出：


 {
    "httpMethod": "GET",
    "authorizationType": "CUSTOM",
    "authorizerId" : "e4f5g6",
    "apiKeyRequired": false,
    "methodResponses": {
        "200": {
            "statusCode": "200",
            "responseModels": {}
        }
    },
    "methodIntegration": {
        "type": "AWS",
        "httpMethod": "POST",
        "uri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789111:function:hello-world/invocations",
        "passthroughBehavior": "WHEN_NO_MATCH",
        "contentHandling": "CONVERT_TO_TEXT",
        "timeoutInMillis": 29000,
        "cacheNamespace": "h7i8j9",
        "cacheKeyParameters": [],
        "integrationResponses": {
            "200": {
                "statusCode": "200",
                "responseTemplates": {}
            }
        }
    }
}

如需詳細資訊，請參閱 Amazon API Gateway 開發人員指南中的使用 Word Gateway CLI 和 REST 建立、設定和測試用量計劃API，以及控制和管理 REST API Gateway API中 Word 的存取。 API

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateMethod。

下列程式碼範例示範如何使用 update-model。

AWS CLI

若要變更 API 中模型的描述

命令：


aws apigateway update-model --rest-api-id 1234123412 --model-name 'Empty' --patch-operations op=replace,path=/description,value='New Description'

若要變更 API 中模型的結構描述

命令：


aws apigateway update-model --rest-api-id 1234123412 --model-name 'Empty' --patch-operations op=replace,path=/schema,value='"{ \"$schema\": \"http://json-schema.org/draft-04/schema#\", \"title\" : \"Empty Schema\", \"type\" : \"object\" }"'

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateModel。

下列程式碼範例示範如何使用 update-resource。

AWS CLI

移動資源並將其放置在 API 中的不同父資源下

命令：


aws apigateway update-resource --rest-api-id 1234123412 --resource-id 1a2b3c --patch-operations op=replace,path=/parentId,value='3c2b1a'

輸出：


{
    "path": "/resource",
    "pathPart": "resource",
    "id": "1a2b3c",
    "parentId": "3c2b1a"
}

若要重新命名 pathPart 中的資源 (API)

命令：


aws apigateway update-resource --rest-api-id 1234123412 --resource-id 1a2b3c --patch-operations op=replace,path=/pathPart,value=newresourcename

輸出：


{
    "path": "/newresourcename",
    "pathPart": "newresourcename",
    "id": "1a2b3c",
    "parentId": "3c2b1a"
}

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateResource。

下列程式碼範例示範如何使用 update-rest-api。

AWS CLI

若要變更 API 的名稱

命令：


aws apigateway update-rest-api --rest-api-id 1234123412 --patch-operations op=replace,path=/name,value='New Name'

若要變更 API 的描述

命令：


aws apigateway update-rest-api --rest-api-id 1234123412 --patch-operations op=replace,path=/description,value='New Description'

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateRestApi。

下列程式碼範例示範如何使用 update-stage。

AWS CLI

範例 1：覆寫資源和方法的階段設定

下列update-stage範例會覆寫階段設定，並關閉特定資源和方法的完整請求/回應記錄。


aws apigateway update-stage \
    --rest-api-id 1234123412 \
    --stage-name 'dev' \
    --patch-operations op=replace,path=/~1resourceName/GET/logging/dataTrace,value=false

輸出：


{
    "deploymentId": "5ubd17",
    "stageName": "dev",
    "cacheClusterEnabled": false,
    "cacheClusterStatus": "NOT_AVAILABLE",
    "methodSettings": {
        "~1resourceName/GET": {
            "metricsEnabled": false,
            "dataTraceEnabled": false,
            "throttlingBurstLimit": 5000,
            "throttlingRateLimit": 10000.0,
            "cachingEnabled": false,
            "cacheTtlInSeconds": 300,
            "cacheDataEncrypted": false,
            "requireAuthorizationForCacheControl": true,
            "unauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER"
        }
    },
    "tracingEnabled": false,
    "createdDate": "2022-07-18T10:11:18-07:00",
    "lastUpdatedDate": "2022-07-18T10:19:04-07:00"
}

如需詳細資訊，請參閱 Amazon REST Gateway 開發人員指南API中的設定 Word 的階段。 API

範例 2：更新 API 階段所有資源和方法的階段設定

下列update-stage範例會開啟 API 階段所有資源和方法的完整請求/回應記錄。


aws apigateway update-stage \
    --rest-api-id 1234123412 \
    --stage-name 'dev' \
    --patch-operations 'op=replace,path=/*/*/logging/dataTrace,value=true'

輸出：


{
    "deploymentId": "5ubd17",
    "stageName": "dev",
    "cacheClusterEnabled": false,
    "cacheClusterStatus": "NOT_AVAILABLE",
    "methodSettings": {
        "*/*": {
            "metricsEnabled": false,
            "dataTraceEnabled": true,
            "throttlingBurstLimit": 5000,
            "throttlingRateLimit": 10000.0,
            "cachingEnabled": false,
            "cacheTtlInSeconds": 300,
            "cacheDataEncrypted": false,
            "requireAuthorizationForCacheControl": true,
            "unauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER"
        }
    },
    "tracingEnabled": false,
    "createdDate": "2022-07-18T10:11:18-07:00",
    "lastUpdatedDate": "2022-07-18T10:31:04-07:00"
}

如需詳細資訊，請參閱 Amazon REST Gateway 開發人員指南API中的設定 Word 的階段。 API

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateStage。

下列程式碼範例示範如何使用 update-usage-plan。

AWS CLI

變更用量計劃中定義的期間

命令：


aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/quota/period",value="MONTH"

若要變更用量計劃中定義的配額限制

命令：


aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/quota/limit",value="500"

若要變更用量計劃中定義的限流率限制

命令：


aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/throttle/rateLimit",value="10"

若要變更用量計劃中定義的限流爆量限制

命令：


aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/throttle/burstLimit",value="20"

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateUsagePlan。

下列程式碼範例示範如何使用 update-usage。

AWS CLI

在用量計劃中定義的目前期間內暫時修改 API 金鑰上的配額

命令：


aws apigateway update-usage --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu --patch-operations op="replace",path="/remaining",value="50"

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateUsage。

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

ACM

API Gateway HTTP 和 WebSocket APIWord

使用 的 API Gateway 範例 AWS CLI

主題

動作

使用的 API Gateway 範例 AWS CLI