Skip to main content
Astra Automation
简体中文版经机器翻译而成，仅供参考。如与英语版出现任何冲突，应以英语版为准。

检索账户

PDF

GET /accounts/{account_id}

返回 JSON 响应正文中存储的 Account API 资源。

参数

名称 Type 在 Required Description

account_id

string

path

True

要列出的帐户集合的 ID

  • 示例：{{.Account}}

响应

Status: 200, Returns the stored Account API resource in the JSON response body.
名称 Type Required Description

type

string

True

资源的媒体类型。定义的值为：

  • "application/astra-account"

version

string

True

资源的版本。定义的值为：

  • "1.0"

id

string

True

资源的全局唯一标识符。定义的值为：

  • 符合 UUIDv4 架构

name

string

True

包含帐户名称的 JSON 字符串。定义的值是：

  • 最小长度：1

  • 最大长度：63

  • 此字符串经过内部验证，以防止 XSS、Unicode、目录遍历和 SQL 注入攻击。

状态

string

True

包含指示帐户操作状态的值的 JSON 字符串。定义的值为：

  • "pending" - 只能对帐户下的用户和角色资源进行更改（默认值）

  • "active" - 可以对帐户下的任何资源进行更改

  • "deletePending" - 用户无法登录，数据保护操作暂停，费用不再累计

isEnabled

string

True

表示已启用帐户的 JSON 字符串。定义的值为：

  • "false" - 不允许用户使用此帐户

  • "true" - 允许用户使用此帐户

enabledTimestamp

string

False

JSON 字符串，包含指示上次启用帐户的时间的时间戳。如果帐户从未启用，则此字段不存在。定义的值为：

  • 符合 ISO-8601 日期时间方案

accountContact

"accountContact"

False

JSON 对象包含用户联系信息，用于在帐户激活时创建所有者用户。

元数据

"type_astra_metadata_update"

True

与资源关联的客户端和服务指定的元数据。定义的值为：

  • 符合 Astra 元数据架构如果在创建时未指定，则将创建没有标签的元数据对象。如果在更新时未指定，则元数据对象的标签、creationTimestamp 和 createdBy 将保留而不进行修改。
响应示例 
{
  "type": "application/astra-account",
  "version": "1.0",
  "id": "666a3f38-d4fa-5b62-a391-a69029758d32",
  "name": "fraught-pines",
  "state": "active",
  "isEnabled": "true",
  "enabledTimestamp": "2020-08-06T12:24:52.256624Z",
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

响应

Status: 401, Unauthorized
名称 Type Required Description

type

string

True

标题

string

True

详细信息

string

True

状态

string

True

correlationID

string

False
响应示例 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

响应

Status: 400, Bad request
名称 Type Required Description

type

string

True

标题

string

True

详细信息

string

True

状态

string

True

correlationID

string

False

invalidParams

数组["invalidParams"]

False

无效查询参数列表
响应示例 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

响应

Status: 403, Forbidden
名称 Type Required Description

type

string

True

标题

string

True

详细信息

string

True

状态

string

True

correlationID

string

False
响应示例 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

错误

Status: 404, Not found
名称 Type Required Description

type

string

True

标题

string

True

详细信息

string

True

状态

string

True

correlationID

string

False
错误响应示例 
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

定义

查看定义

postalAddress

包含指定地址的 JSON 字符串集合的 JSON 对象。如果此键不存在，则表示未提供地址。如果此键存在，则所有六个包含的 JSON 字符串都将存在。如果不提供任何内容，字符串将为空。

名称 Type Required Description

addressCountry

string

True

包含与邮政地址关联的国家/地区名称或国家/地区代码的 JSON 字符串，如 ISO 3166 Alpha-2 中所指定。定义的值为：

  • 最小长度：2

  • 最大长度：2

addressLocality

string

True

包含与邮政地址关联的地点（例如城市）的 JSON 字符串。定义的值为：

  • 最小长度：1

  • 最大长度：63

addressRegion

string

True

包含与邮政地址关联的区域（例如州）的 JSON 字符串。定义的值为：

  • 最小长度：1

  • 最大长度：63

postalCode

string

True

包含与邮政地址关联的邮政编码的 JSON 字符串。定义的值为：

  • 最小长度：1

  • 最大长度：31

streetAddress1

string

True

包含与邮政地址关联的街道地址的 JSON 字符串。定义的值为：

  • 最小长度：1

  • 最大长度：63

streetAddress2

string

False

包含可选辅助街道地址信息、邮政信箱等的 JSON 字符串。定义的值为：

  • 最小长度：1

  • 最大长度：63

accountContact

JSON 对象包含用户联系信息，用于在帐户激活时创建所有者用户。

名称 Type Required Description

firstName

string

True

包含用户指定的长格式名字的 JSON 字符串。定义的值为：

  • 最小长度：1

  • 最大长度：63

  • 此字符串经过内部验证，以防止 XSS、Unicode、目录遍历和 SQL 注入攻击。

lastName

string

True

包含用户指定的长格式姓氏的 JSON 字符串。定义的值为：

  • 最小长度：1

  • 最大长度：63

  • 此字符串经过内部验证，以防止 XSS、Unicode、目录遍历和 SQL 注入攻击。

companyName

string

False

包含与用户关联的公司名称的 JSON 字符串。如果此密钥不存在，则表示未提供公司名称。定义的值为：

  • 最小长度：1

  • 最大长度：63

  • 此字符串经过内部验证，以防止 XSS、Unicode、目录遍历和 SQL 注入攻击。

电子邮件

string

True

包含用户指定的电子邮件地址的 JSON 字符串。定义的值是：

  • 最小长度：1

  • 最大长度：63

电话

string

False

包含用户电话号码的 JSON 字符串。如果此密钥不存在，则表示未提供电话号码。定义的值为：

  • 最小长度：1

  • 最大长度：31

postalAddress

"postalAddress"

True

包含指定地址的 JSON 字符串集合的 JSON 对象。如果此键不存在，则表示未提供地址。如果此键存在，则所有六个包含的 JSON 字符串都将存在。如果不提供任何内容，字符串将为空。

类型 Astra 标签

名称 Type Required Description

name

string

True

value

string

True

type_astra_metadata_update

与资源关联的客户端和服务指定的元数据。定义的值为：

  • 符合 Astra 元数据架构如果在创建时未指定，则将创建没有标签的元数据对象。如果在更新时未指定，则元数据对象的标签、creationTimestamp 和 createdBy 将保留而不进行修改。

名称 Type Required Description

labels

数组["类型 Astra 标签"]

False

creationTimestamp

string

False

modificationTimestamp

string

False

已创建

string

False

modifiedBy

string

False

invalidParams

名称 Type Required Description

name

string

True

无效查询参数的名称

原因

string

True

查询参数无效的原因