本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
CreateProfile
创建用于 AS2 传输的本地或合作伙伴配置文件。
请求语法
{
"As2Id": "string
",
"CertificateIds": [ "string
" ],
"ProfileType": "string
",
"Tags": [
{
"Key": "string
",
"Value": "string
"
}
]
}
请求参数
有关适用于所有操作的参数的信息,请参阅Comm Parameters (常用参数) 有关适用于所有操作的参数的信息。
请求接受采用 JSON 格式的以下数据。
- As2Id
-
As2Id
是 AS2-name,如 RFC 4130中所定义。对于入站传输,这是合作伙伴发送的 AS2 消息的 AS2-From
标头。对于出站连接器,这是使用StartFileTransfer
API 操作发送给合作伙伴的 AS2 消息的AS2-To
标头。此 ID 不能包含空格。类型:字符串
长度限制:最小长度为 1。最大长度为 128。
模式:
^[\p{Print}\s]*
必需:是
- CertificateIds
-
已导入证书的标识符数组。您可以使用此标识符来处理配置文件和合作伙伴配置文件。
类型:字符串数组
长度限制:固定长度为 22。
模式:
^cert-([0-9a-f]{17})$
必需:否
- ProfileType
-
确定要创建的配置文件类型:
-
指定
LOCAL
创建本地配置文件。本地配置文件代表启用了 AS2 的 Transfer Family 服务器组织或派对。 -
指定
PARTNER
创建合作伙伴档案。合作伙伴简介代表 Transfer Family 外部的远程组织。
类型:字符串
有效值:
LOCAL | PARTNER
必需:是
-
- Tags
-
可用于分组和搜索 AS2 配置文件的键/值对。
类型:Tag 对象数组
数组成员:最少 1 项。最多 50 项。
必需:否
响应语法
{
"ProfileId": "string"
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回的以下数据。
- ProfileId
-
AS2 配置文件的唯一标识符,在 API 调用成功后返回。
类型:字符串
长度限制:固定长度为 19。
模式:
^p-([0-9a-f]{17})$
错误
有关所有操作常见错误的信息,请参阅常见错误。
- InternalServiceError
-
当 Transfer Family 服务中发生错误时,会Amazon引发此异常。
HTTP 状态代码:500
- InvalidRequestException
-
当客户端提交格式错误的请求时,会引发此异常。
HTTP 状态代码:400
- ResourceNotFoundException
-
当 Transfer Family 服务找不到资源时,会Amazon引发此异常。
HTTP 状态代码:400
- ServiceUnavailableException
-
由于 Transfer FamAmazon ily 服务不可用,请求失败。
HTTP 状态代码:500
- ThrottlingException
-
由于请求限制而导致请求被拒绝。
HTTP 状态代码:400
示例
示例
以下示例创建一个配置文件,并返回配置文件 ID。
证书 ID 是在您运行时创建的import-certificate
,一个用于签名证书,另一个用于加密证书。
aws transfer create-profile --as2-id MYCORP --certificate-ids c-abcdefg123456hijk c-987654aaaa321bbbb
示例响应
API 调用返回新配置文件的配置文件 ID。
{ "ProfileId": "p-11112222333344444" }
另请参阅
有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: