搜索凭据列表 - ListCredentials
功能介绍
搜索凭据列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/credentials
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 只能由英文字母、数字组成,且长度为32~64个字符。 默认取值: 不涉及 |
| workspace_id | 是 | String | 参数解释: 工作空间ID,用于明确工作空间归属,配置后可通过该ID查询工作空间下资产,可以通过调用API获取,也可以从控制台获取。 约束限制: 不涉及 取值范围: 只能由英文字母、数字、中划线组成,UUID格式,且长度为32~64个字符。 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 否 | String | 参数解释: 厂商名称,用于按名称搜索厂商。 约束限制: 不涉及 取值范围: 只能由英文字母、数字、中文、下划线、中划线、点号组成,且长度为0~64个字符。 默认取值: 不涉及 |
| type | 否 | String | 参数解释: 凭据类型,用于按类型筛选凭据列表。 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| enabled | 否 | Boolean | 参数解释: 是否启用,用于按启用状态筛选凭据列表。 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| built_in | 否 | Boolean | 参数解释: 是否内置,用于按是否内置筛选凭据列表。 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| from_date | 否 | String | 参数解释: 开始时间,用于筛选创建时间大于等于该时间的数据。 约束限制: 开始时间和结束时间必须同时设置。 取值范围: UTC时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ,例如2026-07-02T18:05:21.975+08:00。 默认取值: 不涉及 |
| to_date | 否 | String | 参数解释: 结束时间,用于筛选创建时间小于等于该时间的数据。 约束限制: 开始时间和结束时间必须同时设置。 取值范围: UTC时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ,例如2026-07-02T18:05:21.975+08:00。 默认取值: 不涉及 |
| order | 否 | String | 参数解释: 排序字段,用于指定列表的排序方式,格式为"排序字段:排序方向",多字段排序以逗号分隔。 约束限制: 排序字段必须在可排序列范围内,排序方向仅支持asc和desc(不区分大小写),格式不符合要求的部分会被忽略。 取值范围: 排序字段: 排序方向: 默认取值: 不涉及 |
| offset | 否 | Integer | 参数解释: 偏移量,表示从该偏移量开始查询。 约束限制: 不涉及 取值范围: 0~10000 默认取值: 0 |
| limit | 否 | Integer | 参数解释: 每页数量,表示每页返回的最大记录数。 约束限制: 不涉及 取值范围: 1~1000 默认取值: 10 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于任务追踪。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| code | String | 参数解释: 响应码,用于标识请求是否成功。 取值范围: |
| message | String | 参数解释: 响应消息,用于返回操作提示信息。 取值范围: 长度为0~1024个字符。 |
| request_id | String | 参数解释: 请求ID,用于唯一标识一次请求,便于问题追踪。 取值范围: UUID格式,且长度为0~128个字符。 |
| success | Boolean | 参数解释: 是否成功,用于标识请求是否处理成功。 取值范围: |
| data | Array of CredentialListResponseBody objects | 参数解释: 凭据列表数据。 取值范围: 0~100条记录 |
| total | Integer | 参数解释: 符合条件的数据总数。 取值范围: 0~10000 |
| size | Integer | 参数解释: 当前请求分页大小。 取值范围: 1~1000 |
| page | Integer | 参数解释: 当前请求页数。 取值范围: 0~999999999 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 凭据ID,用于唯一标识一个凭据。 取值范围: 只能由英文字母、数字、中划线组成,UUID格式,且长度为32~64个字符。 |
| name | String | 参数解释: 凭据名称,用于标识凭据。 取值范围: 只能由英文字母、数字、中文、下划线、中划线、点号组成,且长度为1~64个字符。 |
| type | String | 参数解释: 凭据类型,用于区分不同类型的凭据。 取值范围: |
| config | String | 参数解释: 凭据配置,用于存储凭据的具体配置信息,JSON格式字符串。 取值范围: JSON格式字符串,且JSON格式字符串,且长度为0~65535个字符。 |
| description | String | 参数解释: 凭据描述,用于描述凭据的详细信息。 取值范围: 长度为0~65535个字符。 |
| enabled | Boolean | 参数解释: 是否启用,用于标识凭据是否已启用。 取值范围: |
| built_in | Boolean | 参数解释: 是否内置,用于标识凭据是否为系统内置凭据。 取值范围: |
| creator_name | String | 参数解释: 创建者名称,用于标识创建该凭据的用户名称。 取值范围: 只能由英文字母、数字、中文、下划线、中划线、点号组成,且长度为0~64个字符。 |
| modifier_name | String | 参数解释: 修改者名称,用于标识最近修改该凭据的用户名称。 取值范围: 只能由英文字母、数字、中文、下划线、中划线、点号组成,且长度为0~64个字符。 |
| create_time | String | 参数解释: 创建时间,用于记录凭据的创建时间。使用UTC+8时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSS+08:00。 取值范围: 不涉及 |
| update_time | String | 参数解释: 更新时间,用于记录凭据的最近更新时间。使用UTC+8时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSS+08:00。 取值范围: 不涉及 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-request-id | String | 参数解释: 请求ID,用于任务追踪。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,用于标识错误类型。 取值范围: 只能由英文字母、数字、点号组成,且长度为0~64个字符。 |
| error_msg | String | 参数解释: 错误描述,用于描述错误的详细信息。 取值范围: 长度为0~1024个字符。 |
请求示例
在某个工作空间搜索凭据列表的请求样例
https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/credentials 响应示例
状态码:200
{
"code" : "00000000",
"message" : "",
"data" : [ {
"id" : "28f61af50fc9452aa0ed5ea25c3cc3d3",
"name" : "demo_credential",
"type" : "datasource",
"config" : "{\"access_key\": \"AK******\", \"secret_key\": \"SK******\"}",
"description" : "示例凭据",
"enabled" : true,
"built_in" : false,
"creator_name" : "l0******",
"modifier_name" : "",
"create_time" : "2026-07-02T18:05:21.975+08:00",
"update_time" : "2026-07-02T18:05:21.975+08:00"
} ],
"request_id" : "",
"success" : true,
"total" : 1,
"size" : 10,
"page" : 0
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 凭据列表 |
| 400 | 错误响应 |
错误码
请参见错误码。