修改集群密码

最近更新时间:2024-03-12 01:49:14

我的收藏

1. 接口描述

接口请求域名: tcaplusdb.tencentcloudapi.com 。

修改指定集群的密码,后台将在旧密码失效之前同时支持TcaplusDB SDK使用旧密码和新密码访问数据库。在旧密码失效之前不能提交新的密码修改请求,在旧密码失效之后不能提交修改旧密码过期时间的请求。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyClusterPassword。
Version String 公共参数,本接口取值:2019-08-23。
Region String 公共参数,详见产品支持的 地域列表
ClusterId String 需要修改密码的集群ID
示例值:23311894780
OldPassword String 集群旧密码
示例值:canmkdmk1215LM
OldPasswordExpireTime Timestamp 集群旧密码预期失效时间
示例值:2019-08-26%2017%3A25%3A00
NewPassword String 集群新密码,密码必须是a-zA-Z0-9的字符,且必须包含数字和大小写字母
示例值:99c59cb345c61063db
Mode String 更新模式: 1 更新密码;2 更新旧密码失效时间,默认为1 模式
示例值:1

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改集群密码

修改集群密码

输入示例

https://tcaplusdb.tencentcloudapi.com/?Action=ModifyClusterPassword
&ClusterId=23311894780
&OldPassword=canmkdmk1215LM
&NewPassword=99c59cb345c61063db
&OldPasswordExpireTime=2020-09-22 00:00:00
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "8cEcE3E8-2fE2-6d4b-5E34-Fdc01E35f2C6"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.OldPasswordHasExpired 旧密码已经失效。
FailedOperation.OldPasswordInUse 旧密码还未失效。
FailedOperation.PasswordFailure 密码错误。
InternalError 内部错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.InvalidTimeValue 非法的时间格式。
ResourceNotFound 资源不存在。
UnsupportedOperation 操作不支持。