使用任 Job 管理 API - AWS Snowcone 用户指南

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

使用任 Job 管理 API

借助任务管理 API,您能以编程方式访问中的相同功能。AWS 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. 以下是一些示例,可帮助您了解终端节点的故障。

区域 Endpoint
美国东部(弗吉尼亚北部) snowball.us-east-1.amazonaws.com
美国西部(俄勒冈) snowball.us-west-2.amazonaws.com

JMAPI CLI 命令

Job 管理 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 示例是格式正确的 JSON 文件,用于使用AWS KMS策略文件。

{ "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" }

创建 Job 示例

以下命令显示了一个用于运行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 类型的雪锥设备具有 T14 容量首选项并提供第二 _DAY 配送选项。