1. 接口描述
接口请求域名: ssm.tencentcloudapi.com 。
该接口用于获取所有凭据的详细列表,可以指定过滤字段、排序方式等。
默认接口请求频率限制:30次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ListSecrets。 |
Version | 是 | String | 公共参数,本接口取值:2019-09-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Offset | 否 | Integer | 查询列表的起始位置,以0开始,不设置默认为0。 示例值:0 |
Limit | 否 | Integer | 单次查询返回的最大数量,0或不设置则使用默认值 20。 示例值:2 |
OrderType | 否 | Integer | 根据创建时间的排序方式,0或者不设置则使用降序排序, 1 表示升序排序。 示例值:0 |
State | 否 | Integer | 根据凭据状态进行过滤。 默认为0表示查询全部。 1 -- 表示查询Enabled 凭据列表。 2 -- 表示查询Disabled 凭据列表。 3 -- 表示查询PendingDelete 凭据列表。 4 -- 表示PendingCreate。 5 -- 表示CreateFailed。 其中状态PendingCreate和CreateFailed只有在SecretType为云产品凭据时生效 示例值:0 |
SearchSecretName | 否 | String | 根据凭据名称进行过滤,为空表示不过滤。 示例值:testName |
TagFilters.N | 否 | Array of TagFilter | 标签过滤条件。 |
SecretType | 否 | Integer | 0 -- 表示用户自定义凭据,默认为0。 1 -- 表示用户云产品凭据。 2 -- 表示SSH密钥对凭据。 3 -- 表示云API密钥对凭据。 示例值:1 |
ProductName | 否 | String | 此参数仅在SecretType参数值为1时生效, 当SecretType值为1时: 如果ProductName值为空,则表示查询所有类型的云产品凭据; 如果ProductName值为某个指定的云产品值如Mysql时,则表示查询Mysql数据库凭据; 如果ProductName值为多个云产品值,如:Mysql,Tdsql-mysql,Tdsql_C_Mysql(多个值以英文逗号,分隔开)则表示查询三种云产品类型的凭据; 支持的云产品列表请通过接口:DescribeSupportedProducts进行查询。 示例值:Mysql |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 根据State和SearchSecretName 筛选的凭据总数。 示例值:8 |
SecretMetadatas | Array of SecretMetadata | 返回凭据信息列表。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取凭据详细信息列表
输入示例
https://ssm.tencentcloudapi.com/?Action=ListSecrets
&Limit=2
&SecretType=0
&<公共请求参数>
输出示例
{
"Response": {
"TotalCount": 1,
"SecretMetadatas": [
{
"SecretName": "abc",
"Description": "abc",
"KmsKeyId": "abc",
"CreateUin": 1,
"Status": "abc",
"DeleteTime": 1,
"CreateTime": 1,
"KmsKeyType": "abc",
"RotationStatus": 0,
"NextRotationTime": 1,
"SecretType": 0,
"ProductName": "abc",
"ResourceName": "abc",
"ProjectID": 0,
"AssociatedInstanceIDs": [
"abc"
],
"TargetUin": 1,
"RotationFrequency": 0,
"ResourceID": "abc",
"RotationBeginTime": "abc"
}
],
"RequestId": "abc"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameterValue | 参数取值错误。 |
ResourceUnavailable.NotPurchased | 服务未购买。 |
UnauthorizedOperation | 未授权操作。 |