查询密钥列表
最近更新时间: 2024-10-18 10:38:32
1. 接口描述
接口请求域名: apigateway.api3.fincloud.tencent.cn。
本接口(DescribeApiKeysStatus)用于查询密钥列表。 当用户创建了多个密钥对时,可使用本接口查询一个或多个 API 密钥信息,本接口不会显示密钥 Key。
默认接口请求频率限制:20次/秒。
接口更新时间:2020-06-02 11:27:53。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:DescribeApiKeysStatus |
Version | 是 | 否 | String | 公共参数,本接口取值:2018-08-08 |
Region | 是 | 否 | String | 公共参数,详见产品支持的地域列表(TODO) |
Limit | 否 | 否 | Int64 | 返回数量,默认为 20,最大值为 100。 |
Offset | 否 | 否 | Int64 | 偏移量,默认为 0。 |
Filters | 否 | 否 | Array of Filter | 过滤条件。支持AccessKeyId、AccessKeySecret、SecretName、NotUsagePlanId、Status、KeyWord( 可以匹配name或者path)。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | ApiKeysStatus | 密钥列表。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue.InvalidRegion |