文档中心

API 网关

消费者管理

ListConsumerCredentials - 查询消费者凭证列表

批量查询消费者凭证详情。

请求说明

API 网关已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地域，选择最合适的接入点。

请求方式：POST

请求地址：https://apig.cn-beijing.volcengineapi.com?Action=ListConsumerCredentials&Version=2021-03-03

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：ListConsumerCredentials

要执行的操作，取值：ListConsumerCredentials。

Version string 必选示例值：2021-03-03

API的版本，取值：2021-03-03。

PageNumber long 可选示例值：1

分页查询的页号。取值最小限制为1，默认值为 1。

PageSize long 可选示例值：10

每页个数。取值限制为 0~100，默认值为 0。

ConsumerId string 必选示例值：consumer-crbc****

消费者 ID。您可以通过 ListConsumers 查询消费者 ID。

CredentialType string 必选示例值：hmac-auth

凭证类型，取值：

hmac-auth：HMAC 凭证。

key-auth：API Key 凭证。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

Total long 示例值：10

过滤后的总个数。

Items object[] 示例值：-

消费者凭证列表。

Id string 示例值：credential-cf8t****

消费者凭证 ID。

CredentialType string 示例值：hmac-auth

凭证类型，取值：

hmac-auth：HMAC 凭证。

key-auth：API Key 凭证。

HmacAuthCredential object 示例值：-

HMAC 凭证。

AccessKey string 示例值：APIGND****

Access key。

SecretKey string 示例值：MmMyZ****

Secret key。

Enable boolean 示例值：true

是否开启 HMAC 凭证。取值：

true：开启。

false：不开启。

KeyAuthCredential object 示例值：-

API Key 凭证。

APIKey string 示例值：c4cc2338-d85****

API key。

Enable boolean 示例值：true

是否开启 API Key 凭证。取值：

true：开启。

false：不开启。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	The specified parameter %s is invalid.	请求参数值不合法。请确认参数后重试。
500	InternalError	The request has failed due to an unknown error.	未知错误。请稍后重试。如果多次尝试失败，请提交工单。

最近更新时间：2026.10.28 14:59:50

这个页面对您有帮助吗？

有用

无用