模拟故障接口

最近更新时间:2024-11-22 12:05:09

我的收藏

1. 接口描述

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

本接口(KillMasterGroup)用于模拟故障。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:KillMasterGroup。
Version String 公共参数,本接口取值:2018-04-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 指定实例 ID。例如:crs-xjhsdj****。请登录Redis控制台在实例列表复制实例 ID。
示例值:crs-dfndi7de
Password String 该参数用于配置指定实例的访问密码。若为免密认证,该参数则无需配置。密码复杂度要求如下所示。
- 长度8-30位,推荐使用12位以上的密码
- 不能以"/"开头
- 至少包含小写字母a-z、大写字母A-Z、数字0-9及其 ()`~!@#$%^&*-+=_|{}[]:;<>,.?/中的两项。
示例值:12345Aa
ShardIds.N Array of Integer 分片集群的分片 ID。请通过接口DescribeInstanceNodeInfo 的返回参数 Redis 中的 ClusterId 获取。
示例值:null

3. 输出参数

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

4. 示例

示例1 请求示例

故障模拟

输入示例

POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: KillMasterGroup
<公共请求参数>

{
    "InstanceId": "crs-joak5XXX",
    "Password": "pwd@1234",
    "ShardIds": [
        0
    ]
}

输出示例

{
    "Response": {
        "RequestId": "da6b0bea-7aab-4d4b-b819-d524f4c9eXXX",
        "TaskId": 1682324000
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.InvalidAuthorization 认证无效。
FailedOperation.SystemError 内部系统错误,和业务无关。
FailedOperation.UnSupportError 实例不支持该接口。
InternalError.InternalError 内部错误。
InvalidParameter.IllegalParameterError 非法参数错误。
InvalidParameter.InvalidParameter 业务参数错误。
InvalidParameter.PermissionDenied 接口没有cam权限。
InvalidParameterValue.PasswordEmpty 密码为空。
InvalidParameterValue.PasswordError 密码校验出错,密码错误。
InvalidParameterValue.PasswordRuleError 设置密码时,MC 传入的 old password 与先前设定密码不同。
ResourceNotFound.InstanceNotExists 根据 serialId 没有找到对应 redis。
ResourceUnavailable.InstanceNotSupportOperation 实例状态不支持操作。
ResourceUnavailable.InstanceStatusError 实例状态异常,不能执行对应操作。