1. 接口描述
接口请求域名: ssm.tencentcloudapi.com 。
查询凭据轮转策略详情。
本接口只适用于云产品凭据。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRotationDetail。 |
Version | 是 | String | 公共参数,本接口取值:2019-09-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
SecretName | 是 | String | 指定需要获取凭据轮转详细信息的凭据名称。 示例值:test3-db-secret |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
EnableRotation | Boolean | 否允许轮转,true表示开启轮转,false表示禁止轮转。 示例值:true |
Frequency | Integer | 轮转的频率,以天为单位,默认为1天。 示例值:30 |
LatestRotateTime | String | 最近一次轮转的时间,显式可见的时间字符串,格式 2006-01-02 15:04:05。 示例值:2021-01-02 15:04:05 |
NextRotateBeginTime | String | 下一次开始轮转的时间,显式可见的时间字符串,格式 2006-01-02 15:04:05。 示例值:2021-02-02 15:04:05 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询凭据轮转详情
输入示例
https://ssm.tencentcloudapi.com/?Action=DescribeRotationDetail
&SecretName=test3-db-secret
&<公共请求参数>
输出示例
{
"Response": {
"EnableRotation": true,
"Frequency": 30,
"LatestRotateTime": "2024-10-30 16:24:48",
"NextRotateBeginTime": "2024-10-31 11:11:00",
"RequestId": "d44e1c39-1e87-4ebe-ac8f-e06d0885971d"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
FailedOperation.AccessKmsError | KMS操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.TagKeysDuplicated | 标签键重复。 |
InvalidParameterValue.TagsNotExisted | 标签键或标签值不存在。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.AutoRotatedResource | 不允许手动更新具有自动轮换功能的凭据。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInUse.SecretExists | 凭据名已存在。 |
ResourceInUse.VersionIdExists | 版本号已存在。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourceUnavailable.NotPurchased | 服务未购买。 |
ResourceUnavailable.ResourceDisabled | 凭据被禁用。 |
ResourceUnavailable.ResourcePendingDeleted | 凭据处于计划删除状态。 |
ResourceUnavailable.ResourceUninitialized | 凭据未完成初始化。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.AccessKmsError | 访问KMS失败。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |