创建账号(推荐) - CreateAccountV2
功能介绍
创建一个账号,不携带手机号邮箱联系方式,生成的账号将自动成为调用此接口的账号所属组织的成员。此操作只能由组织的管理账号调用。组织云服务将在新账号中创建所需的服务关联委托和账号访问委托。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v2/organizations/accounts
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Security-Token | 否 | String | 参数解释: 如果正在使用临时安全凭据,则此 header 是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 约束限制: 不涉及 取值范围: 最小长度0、最大长度32768。 默认取值: 无默认值 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 参数解释: 账号名称。 约束限制: 必填字段 取值范围: 符合正则表达式:^[a-zA-Z][0-9a-zA-Z_-]+$ 最小长度6、最大长度32。 默认取值: 无默认值 |
| agency_name | 否 | String | 参数解释: 委托名称。 约束限制: 不涉及 取值范围: 符合正则表达式:^[\w-]+$ 最小长度1、最大长度32。 默认取值: 无默认值 |
| description | 否 | String | 参数解释: 描述信息。 约束限制: 不涉及 取值范围: 最小长度0、最大长度128。 默认取值: 无默认值 |
| tags | 否 | Array of TagDto objects | 参数解释: 要绑定到新创建的账号的标签列表。 约束限制: 不涉及 取值范围: 最少0个、最多200个。 默认取值: 无默认值 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| key | 是 | String | 参数解释: 标签键的密钥标识符或名称。 约束限制: 必填字段 取值范围: 符合正则表达式:^((?!sys|\s)[\p{L}\p{Z}\p{N}.:=+-@]*[\p{L}\p{N}.:=+-@])$ 最小长度1、最大长度128。 默认取值: 无 |
| value | 是 | String | 参数解释: 与标签键关联的字符串值。您可以将标签的值设置为空字符串,但不能将标签的值设置为NULL。 约束限制: 必填字段 取值范围: 符合正则表达式:^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$ 最小长度0、最大长度255。 默认取值: 无 |
响应参数
状态码:202
| 参数 | 参数类型 | 描述 |
|---|---|---|
| create_account_status | CreateAccountStatusDto object | 参数解释: 创建账号的请求状态。 约束限制: 必填字段 取值范围: 不涉及 默认取值: 无默认值 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| account_id | String | 参数解释: 如果账号创建成功,则为新账号的唯一标识符(ID)。 约束限制: 必填字段 取值范围: 符合正则表达式:^[\w-]+$ 最大长度64。 默认取值: 无默认值 |
| account_name | String | 参数解释: 账号名称 约束限制: 必填字段 取值范围: 符合正则表达式:^[a-zA-Z][0-9a-zA-Z_-]+$ 最大长度64。 默认取值: 无默认值 |
| completed_at | String | 参数解释: 创建账号和完成请求的日期和时间。 约束限制: 必填字段 取值范围: 符合ISO 8601日期时间格式。 默认取值: 无默认值 |
| created_at | String | 参数解释: 请求创建账号的日期和时间。 约束限制: 必填字段 取值范围: 符合ISO 8601日期时间格式。 默认取值: 无默认值 |
| id | String | 参数解释: 请求的唯一标识符(ID)。您可以从创建账号的初始CreateAccount请求的响应中获得此值。 约束限制: 必填字段 取值范围: 符合正则表达式:^car-[0-9a-z]{8,32}$ 最大长度36。 默认取值: 无默认值 |
| state | String | 参数解释: 创建账号的异步请求的状态,in_progress:处理中,succeeded:成功,failed:失败。 约束限制: 必填字段 取值范围: 最小长度1、最大长度64。 默认取值: 无默认值 |
| failure_reason | String | 参数解释: 如果请求失败,则说明失败原因。 约束限制: 不涉及 取值范围: 最小长度0、最大长度128。 默认取值: 无默认值 |
| failure_detail_msg | failure_detail_msg object | 参数解释: 请求失败详细原因。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 无默认值 |
请求示例
创建账号
POST https://{hostname}/v1/organizations/accounts
{
"name" : "C9Qzukfn6FIyxAmC3dQclrwZW34UDu_rPSRrCQ4aGFm0-r1zC2RDHt5oHA-aY21B",
"tags" : [ {
"key" : "keystring",
"value" : "valuestring"
} ]
} 响应示例
状态码:202
Successful
{
"create_account_status" : {
"account_id" : "0a6d25d23900d45c0faac010e0fb4de0",
"account_name" : "paas_iam_573331",
"completed_at" : "2022-08-24T06:41:15Z",
"created_at" : "2022-08-24T06:41:15Z",
"id" : "h-awjp43m7bz3b8jgy5v61jrfwakt3og8w",
"state" : "in_progress",
"failure_reason" : "string"
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 202 | Successful |
错误码
请参见错误码。