跳转到主要内容
ZStack
身份与访问控制相关接口/凭证

查询凭证列表

可选过滤类型健康状态组件。

GET/api/v1/credentials

操作 ID

ListCredentials

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

  • type
    String

    类型。

    示例： CREDENTIAL_TYPE_UNSPECIFIED

  • healthStatus
    String

    健康状态。

    示例： CREDENTIAL_HEALTH_STATUS_UNSPECIFIED

  • limit
    Integer

    最多返回的记录数。

    示例： 0

  • offset
    Integer

    查询起始偏移量。

    示例： 0

  • componentUuid
    String

    组件UUID。

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • items
    List

    条目列表。

    示例： (nested array)

    • uuid
      String

      资源的UUID，唯一标识该资源。

      示例： cred-a1b2c3d4-e5f6-7890-abcd-ef1234567890

    • name
      String

      资源名称。

      示例： prod-db-password

    • description
      String

      资源的详细描述。

      示例： Primary database password for production environment

    • type
      String

      类型。

      示例： CREDENTIAL_TYPE_UNSPECIFIED

    • healthStatus
      String

      健康度状态。

      示例： CREDENTIAL_HEALTH_STATUS_UNSPECIFIED

    • expiresAt
      String

      过期时间。

      示例： 2026-01-15T08:00:00Z

    • createdBy
      String

      创建该记录的用户UUID。

      示例： admin@example.com

    • createDate
      String

      创建时间。

      示例： 2026-01-15T08:00:00Z

    • lastOpDate
      String

      最近一次操作时间。

      示例： 2026-01-15T08:00:00Z

  • total
    Integer

    返回结果总数。

    示例： 42

  • limit
    Integer

    最大返回条目数。

    示例： 20

  • offset
    Integer

    查询起始偏移量。

    示例： 20