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

检索凭据

PDF

GET /accounts/{account_id}/core/v1/credentials/{credential_id}

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

参数

名称 Type 在 Required Description

account_id

string

path

True

包含帐户资源的 ID

  • 示例：{{.Account}}

凭证 ID

string

path

True

要列出的凭据集合的 ID

响应

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

type

string

True

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

  • "application/astra-credential"

version

string

True

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

  • "1.0"

  • "1.1"

id

string

True

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

  • 符合 UUIDv4 架构

name

string

True

包含用户指定名称的 JSON 字符串。为用户创建凭据时，名称将设置为该用户的 UUID。定义的值为：

  • 最小长度：1

  • 最大长度：127

keyType

string

False

包含可选的用户指定的数据验证类型描述符的 JSON 字符串，用于 keyStore 的内容。扩展更新约束：

  • 如果资源中不存在 keyType 且未在更新中指定，则 keyType 不得在更新的资源中继续存在。

  • 如果资源中不存在 keyType，但在更新时指定了 keyType，则必须将 keyType 添加到资源中并执行验证。如果验证失败，更新将失败。

  • 如果资源中存在 keyType 且未在更新中指定，则必须保留 keyType。

  • 如果资源中存在 keyType 并且在更新中指定了，并且指定的 keyType 与现有的 keyType 匹配，则必须保留 keyType。

  • 如果资源中存在 keyType 并在更新中指定了，并且指定的 keyType 与现有的 keyType 不同，则更新将失败。定义的值是：

  • "generic" - 凭据是一个通用的数据集合。这相当于不包括 keyType。

  • 扩展验证按以下方式执行：

  • 一个或多个字符串必须存在于 keyStore 中。

  • keyStore 中的每个字符串都必须有一个在 base64 中编码的值。

  • "passwordHash" - 凭据是密码哈希。

  • 扩展验证按以下方式执行：

  • 凭据的名称必须是唯一的。

  • 凭据名称必须等于有效的用户资源 ID。

  • 不得更改凭据的名称。

  • 相应的用户资源必须具有 "authProvider" 为 "local"。

  • 在 keyStore 中必须存在一个"明文"字符串，其值包含 base64 编码的明文密码：

  • 此密码明文必须符合该帐户的密码策略。

  • 密码以哈希的形式存储。

  • "change" 字符串必须存在于 keyStore 中，其值包含 base64 编码的字符串 "true" 或 "false"。

  • 只有当名称指示的用户 ID 不存在时，才能删除类型为 passwordHash 的凭据。

  • "apikey" - 凭据是 API 密钥。

  • 扩展验证按以下方式执行：

  • "apikey" 字符串必须存在于 keyStore 中，其值包含 base64 编码的任意字符串。

  • "kubeconfig" - 凭据是 kubeconfig。

  • 扩展验证按以下方式执行：

  • "base64" 字符串必须存在于 keyStore 中，其值包含 base64 编码的 JSON kubeconfig 文件。

  • kubeconfig 文件只能描述单个集群。

  • keyStore 中不能存在其他字段。

  • "certificate" - 凭据是 PEM 编码的证书

  • 扩展验证按以下方式执行：

  • "certificate" 字符串必须存在于 keyStore 中，其值包含 base64 编码的 PEM 证书。

  • "privkey" - 凭据是 PEM 编码的私钥。

  • 扩展验证按以下方式执行：

  • "privkey" 字符串必须存在于 keyStore 中，其值包含 base64 编码的 PEM 私钥。

  • "s3" - 表示用于 Simple Storage Service (S3) 访问的凭据。

  • 扩展验证按以下方式执行：

  • "accessKey" 字符串必须存在于 keyStore 中，其值包含 base64 编码的 S3 访问密钥。

  • "accessSecret" 字符串必须存在于 keyStore 中，其值包含 base64 编码的 S3 访问密钥。

valid

string

True

描述凭据是否可以使用的 JSON 字符串。默认值（如果省略）为"true"。定义的值是：

  • "true" - 凭据有资格使用。

  • "false" - 不得使用凭据。

validFromTimestamp

string

False

包含指示凭据何时有效的时间戳的 JSON 字符串。这些用于凭据轮换。定义的值是：

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

validUntilTimestamp

string

False

包含指示凭据何时不再有效的时间戳的 JSON 字符串。这些用于凭据轮换。定义的值是：

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

元数据

"type_astra_metadata_update"

True

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

  • 符合 Astra 元数据架构如果在创建时未指定，则将创建没有标签的元数据对象。如果在更新时未指定，则元数据对象的标签、creationTimestamp 和 createdBy 将保留而不进行修改。
响应示例 
{
  "type": "application/astra-credential",
  "version": "1.1",
  "id": "58e26f6a-a631-5122-8e0e-7afe306675c0",
  "name": "myCert",
  "valid": "true",
  "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"
}

定义

查看定义

类型 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

查询参数无效的原因