本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
CreateCluster
创建一个空集群。每个集群支持五个节点。您可以分别使用 CreateJob 操作为每个节点创建作业。只有在创建了这五个节点的作业之后,集群才会运送。
请求语法
{
"AddressId": "string
",
"Description": "string
",
"ForceCreateJobs": boolean
,
"ForwardingAddressId": "string
",
"InitialClusterSize": number
,
"JobType": "string
",
"KmsKeyARN": "string
",
"LongTermPricingIds": [ "string
" ],
"Notification": {
"DevicePickupSnsTopicARN": "string
",
"JobStatesToNotify": [ "string
" ],
"NotifyAll": boolean
,
"SnsTopicARN": "string
"
},
"OnDeviceServiceConfiguration": {
"EKSOnDeviceService": {
"EKSAnywhereVersion": "string
",
"KubernetesVersion": "string
"
},
"NFSOnDeviceService": {
"StorageLimit": number
,
"StorageUnit": "string
"
},
"S3OnDeviceService": {
"FaultTolerance": number
,
"ServiceSize": number
,
"StorageLimit": number
,
"StorageUnit": "string
"
},
"TGWOnDeviceService": {
"StorageLimit": number
,
"StorageUnit": "string
"
}
},
"RemoteManagement": "string
",
"Resources": {
"Ec2AmiResources": [
{
"AmiId": "string
",
"SnowballAmiId": "string
"
}
],
"LambdaResources": [
{
"EventTriggers": [
{
"EventResourceARN": "string
"
}
],
"LambdaArn": "string
"
}
],
"S3Resources": [
{
"BucketArn": "string
",
"KeyRange": {
"BeginMarker": "string
",
"EndMarker": "string
"
},
"TargetOnDeviceServices": [
{
"ServiceName": "string
",
"TransferOption": "string
"
}
]
}
]
},
"RoleARN": "string
",
"ShippingOption": "string
",
"SnowballCapacityPreference": "string
",
"SnowballType": "string
",
"TaxDocuments": {
"IND": {
"GSTIN": "string
"
}
}
}
请求参数
有关所有操作的通用参数的信息,请参阅通用参数。
该请求接受以下JSON格式的数据。
- AddressId
-
您要希望将集群运送到的地址的 ID。
类型:字符串
长度限制:固定长度为 40。
模式:
ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
必需:是
- Description
-
此特定集群的可选描述,例如
Environmental Data Cluster-01
。类型:字符串
长度限制:长度下限为 1。长度上限为 1024。
模式:
.*
必需:否
- ForceCreateJobs
-
当用户尝试过度或过少配置集群时,强制创建集群。如果集群的初始大小大于(过度配置)或小于(配置不足)为满足
OnDeviceServiceConfiguration
指定的容量要求所需的大小,则集群处于过度配置或配置不足的状态。类型:布尔值
必需:否
- ForwardingAddressId
-
您所在的地区不支持此字段。
类型:字符串
长度限制:固定长度为 40。
模式:
ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
必需:否
- InitialClusterSize
-
如果提供,每个作业都将自动创建并与新集群相关联。如果未提供,则将被视为 0。
类型:整数
有效范围:最小值为 0。最大值为 16。
必需:否
- JobType
-
此集群的作业类型。目前,
LOCAL_USE
是集群唯一支持的作业类型。有关 Snow 系列设备类型的信息,请参阅 Snowcone 用户指南中的 Snow 系列设备和容量或 Snowball Edge 用户指南中的 Snow 系列设备和容量。
类型:字符串
有效值:
IMPORT | EXPORT | LOCAL_USE
必需:是
- KmsKeyARN
-
您要与此集群关联的
KmsKeyARN
值。KmsKeyARN
值是使用 AWS Key Management Service (AWS KMS) 中的CreateKeyAPI操作创建的。类型:字符串
长度限制:长度上限为 255。
模式:
arn:aws.*:kms:.*:[0-9]{12}:key/.*
必需:否
- LongTermPricingIds
-
列出长期定价 ID,它将用于与为新集群自动创建的作业相关联。
类型:字符串数组
长度限制:固定长度为 41。
模式:
LTPID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
必需:否
- Notification
-
此集群的亚马逊简单通知服务 (AmazonSNS) 通知设置。
类型:Notification 对象
必需:否
- OnDeviceServiceConfiguration
-
指定 Snow Family 设备上将从中导出或导入您传输的数据的一个或多个服务。 AWS Snow Family 设备集群支持 Amazon S3 和NFS(网络文件系统)。
类型:OnDeviceServiceConfiguration 对象
必需:否
- RemoteManagement
-
允许您从内部网络之外安全地远程操作和管理集群中的 Snow 设备。如果设置为
INSTALLED_AUTOSTART
,则远程管理会在设备到达您的位置时自动启用。否则,您需要使用 Snowball 客户端来管理设备。类型:字符串
有效值:
INSTALLED_ONLY | INSTALLED_AUTOSTART | NOT_INSTALLED
必需:否
- Resources
-
与集群作业关联的资源。这些资源包括 Amazon S3 存储桶和用 Python 语言编写的可选 AWS Lambda 函数。
类型:JobResource 对象
必需:否
- RoleARN
-
您
RoleARN
要与此集群关联的。RoleArn
值是使用 AWS Identity and Access Management (IAM) 中的CreateRoleAPI操作创建的。类型:字符串
长度限制:长度上限为 255。
模式:
arn:aws.*:iam::[0-9]{12}:role/.*
必需:否
- ShippingOption
-
此集群中每个节点的配送速度。此速度并不指示您需要多长时间收到每台 Snowball Edge 设备,而是表示每台设备运送到目的地的运输速度。每个区域配送速度如下所示:
-
在澳大利亚,您可以享受快递服务。通常,快递运输 Snow 设备大约需要一天时间。
-
在欧盟 (EU),您可以享受快递服务。通常,快递运输 Snow 设备大约需要一天时间。此外,欧盟的大多数国家/地区还可以使用标准运输,通常单程需要的时间不超过一周。
-
在印度,Snow 设备将在一到七天内送达。
-
在美国 (US),您可以享受次日达和隔日达。
-
在澳大利亚,您可以享受快递服务。通常,快递运输设备大约需要一天时间。
-
在欧盟 (EU),您可以享受快递服务。通常,快递运输 Snow 设备大约需要一天时间。此外,欧盟的大多数国家/地区还可以使用标准运输,通常单程需要的时间不超过一周。
-
在印度,Snow 设备将在一到七天内送达。
-
在美国,您可以享受次日达和隔日达。
类型:字符串
有效值:
SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD
必需:是
-
- SnowballCapacityPreference
-
如果您的作业是在美国某个地区创建的,则可以选择为该作业指定您想要的 Snow 设备尺寸。在所有其他地区,Snowball 的存储容量为 80 TB。
有关 Snow 系列设备类型的信息,请参阅 Snowcone 用户指南中的 Snow 系列设备和容量或 Snowball Edge 用户指南中的 Snow 系列设备和容量。
类型:字符串
有效值:
T50 | T80 | T100 | T42 | T98 | T8 | T14 | T32 | NoPreference | T240 | T13
必需:否
- SnowballType
-
用于此集群的 Snow 系列设备的类型。
注意
对于集群作业,Sno AWS w Family 目前仅支持该
EDGE
设备类型。有关 Snow 系列设备类型的信息,请参阅 Snowcone 用户指南中的 Snow 系列设备和容量或 Snowball Edge 用户指南中的 Snow 系列设备和容量。
类型:字符串
有效值:
STANDARD | EDGE | EDGE_C | EDGE_CG | EDGE_S | SNC1_HDD | SNC1_SSD | V3_5C | V3_5S | RACK_5U_C
必需:是
- TaxDocuments
-
您所需要的税务文件 AWS 区域。
类型:TaxDocuments 对象
必需:否
响应语法
{
"ClusterId": "string",
"JobListEntries": [
{
"CreationDate": number,
"Description": "string",
"IsMaster": boolean,
"JobId": "string",
"JobState": "string",
"JobType": "string",
"SnowballType": "string"
}
]
}
响应元素
如果操作成功,服务将发回 HTTP 200 响应。
以下数据由服务以JSON格式返回。
- ClusterId
-
为集群自动生成的 ID。
类型:字符串
长度限制:固定长度为 39。
模式:
CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
- JobListEntries
-
为此集群创建的作业列表。有关语法,请参阅本指南JobListEntries中的 ListJobsResult$
。 类型:JobListEntry 对象数组
错误
有关所有操作的常见错误的信息,请参阅常见错误。
- Ec2RequestFailedException
-
您的用户缺乏执行尝试操作所必需的 Amazon EC2 权限。
HTTP状态码:400
- InvalidInputCombinationException
-
作业或集群创建失败。一个或多个输入无效。确认CreateCluster:SnowballType值支持您的CreateJob:JobType,然后重试。
HTTP状态码:400
- InvalidResourceException
-
找不到指定的资源。请查看您在上次请求中提供的信息,然后重试。
HTTP状态码:400
- KMSRequestFailedException
-
提供的 AWS Key Management Service 密钥缺少执行指定CreateJob或UpdateJob操作的权限。
HTTP状态码:400
另请参阅
有关API在一种特定语言中使用此功能的更多信息 AWS SDKs,请参阅以下内容: