使用作业管理 API - Amazon Snowcone 用户指南
JMAPI 的常见用途JMAPI 必需字符串JMAPI 端点JMAPI CLI 命令示例
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

使用作业管理 API

借助作业管理 API（JMAPI），您能以编程方式访问 Amazon Snow 系列管理控制台中的相同功能。这使您能够自动执行作业功能。通过使用 JMAPI，您可以查看作业状态、创建作业、下载清单文件、解锁代码和查看作业完成报告。由于调用是通过 API 进行的，因此您可以将这些调用集成到自定义应用程序或 Web 前端中。

JMAPI 的常见用途

  • Snowcone 设备的自动预订

  • 下载清单文件

  • 下载解锁文件

  • 列出当前的 Snowcone 作业

  • 下载 Snowcone 作业完成报告

JMAPI 必需字符串

在通过作业管理 API 下订单时，您可以使用以下必需参数，以下是参数示例。

--job-type
--resources
--address-id
--region
--role-arn
--kms-key-arn
--shipping-option
--device-type
--description

JMAPI 端点

API 端点

要对每个端点进行调用，格式为 snowballEdge.region.amazonaws.com。以下示例可帮助您了解端点细分。

区域 终端节点
美国东部（弗吉尼亚州北部） snowball.us-east-1.amazonaws.com
美国西部（俄勒冈州） snowball.us-west-2.amazonaws.com

JMAPI CLI 命令

作业管理 CLI

以下是您可以对作业管理 API 进行的 CLI 调用。

命令 示例
列出作业 aws snowball list-jobs
描述作业 aws snowball describe-job --job-id [JOB ID]
描述地址 aws snowball describe-address --address-id
创建地址 aws snowball create-address --cli-input-json file://create-address.json
创建作业 aws snowball create-job --cli-input-json file://create-job.json
取消作业 aws snowball cancel-job --job-id [JOB ID]

示例

以下是使用作业管理 API 的命令示例。

KMS JSON 示例

以下 JSON 示例是使用 Amazon KMS 策略文件时正确格式的 JSON 文件。

{
    "KeyMetadata": {
        "Origin": "AWS_KMS",
        "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
        "Description": "",
        "KeyManager": "CUSTOMER",
        "Enabled": true,
        "KeyUsage": "ENCRYPT_DECRYPT",
        "KeyState": "Enabled",
        "CreationDate": 1502910355.475,
        "Arn": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
        "AWSAccountId": "111122223333"
    }
}

创建地址示例

以下示例向您展示了如何设置命令格式来创建地址，以及成功后会得到什么响应。

aws snowball create-address --address "Name=Bob,Company=AWS,Street1=1234 Fake St.,City=All,StateOrProvince=Any,Country=US,PostalCode=12345,PhoneNumber=1234567890"

示例输出

{
    "AddressId": "ADID3be640c8-1111-1111-1111-917f201ffa42"
}

创建作业示例

以下命令向您展示了运行 create-job 命令的示例命令。

aws snowball create-job --job-type IMPORT --resources file://path/to/resources.json --address-id ADID3be640c8-1111-1111-1111-917f201ffa42 --region us-east-1 --role-arn arn:aws:iam::123456789123:role/example_role --kms-key-arn arn:aws:kms:us-west-2:000000000000:key/Example --snowball-capacity-preference T14 --device-configuration file://path/to/configuration.json --shipping-option SECOND_DAY --snowball-type SNC1_SSD

上述 create-job 命令将在 us-east-1 区域创建导入作业，其中一台 SNC1_SSD 类型的 Snowcone 设备具有 T14 容量首选项，并有 SECOND_DAY 运输选项。