You need to enable JavaScript to run this app.
文档中心
API 网关

API 网关

复制全文
下载 pdf
消费者管理
ListConsumerCredentials - 批量查询消费者凭证
复制全文
下载 pdf
ListConsumerCredentials - 批量查询消费者凭证
批量查询消费者凭证详情。​
请求说明​
API 网关已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地域,选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://apig.cn-beijing.volcengineapi.com?Action=ListConsumerCredentials&Version=2021-03-03​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
ListConsumerCredentials​
接口名称。当前 API 的名称为 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 凭证。​
​
请求示例​
​
POST https://apig.cn-beijing.volcengineapi.com?Action=ListConsumerCredentials&Version=2021-03-03​
Content-Type: application/json​
{​
"PageNumber": 1,​
"PageSize": 10,​
"ConsumerId": "consumer-crbc****",​
"CredentialType": "hmac-auth"​
}​
​
返回参数​
​
参数​
类型​
示例值​
描述​
Total​
Long​
10​
过滤后的总个数。​
Items​
Array of CredentialItem​
-​
消费者凭证列表。​
​
CredentialItem​
​
参数​
类型​
示例值​
描述​
Id​
String​
credential-cf8t****​
消费者凭证 ID。​
CredentialType​
String​
hmac-auth​
凭证类型,取值:​
  • hmac-auth:HMAC 凭证。​
  • key-auth:API Key 凭证。​
HmacAuthCredential​
-​
HMAC 凭证。​
KeyAuthCredential​
-​
API Key 凭证。​
​
HmacAuthCredentialItem​
​
参数​
类型​
示例值​
描述​
AccessKey​
String​
APIGND****​
Access key。​
SecretKey​
String​
MmMyZ****​
Secret key。​
Enable​
Boolean​
true​
是否开启 HMAC 凭证。取值:​
  • true:开启。​
  • false:不开启。​
​
KeyAuthCredentialItem​
​
参数​
类型​
示例值​
描述​
APIKey​
String​
c4cc2338-d85****​
API key。​
Enable​
Boolean​
true​
是否开启 API Key 凭证。取值:​
  • true:开启。​
  • false:不开启。​
​
返回示例​
​
Content-Type: application/json​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "ListConsumerCredentials",​
"Version": "2021-03-03",​
"Service": "apig",​
"Region": "cn-beijing"​
},​
"Result": {​
"Total": 10,​
"Items": [​
{​
"Id": "credential-cf8t****",​
"CredentialType": "hmac-auth",​
"KeyAuthCredential": {​
"APIKey": "c4cc2338-d85****",​
"Enable": true​
},​
"HmacAuthCredential": {​
"Enable": true,​
"AccessKey": "APIGND****",​
"SecretKey": "MmMyZ****"​
}​
}​
]​
}​
}​
​
错误码​
本接口无特有的错误码。更多信息请参见 公共错误码。​
最近更新时间:2026.07.29 10:20:05
这个页面对您有帮助吗?
有用
有用
无用
无用