1. 接口描述
接口请求域名: redis.tencentcloudapi.com 。
本接口(ModifyDBInstanceSecurityGroups)用于对实例原有的安全组列表进行修改。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyDBInstanceSecurityGroups。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Product | 是 | String | 数据库引擎名称,本接口取值:redis。 示例值:redis |
SecurityGroupIds.N | 是 | Array of String | 更换为新的安全组 ID 列表,即一个或者多个安全组 ID 组成的数组。若实例第一次配置安全组,请使用接口AssociateSecurityGroups先绑定安全组。 示例值:["sg-ajr1jzgj\n"] |
InstanceId | 是 | String | 实例 ID,格式如:cdb-c1nl9rpv或者cdbro-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。 示例值:crs-eb2w7dto |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
输入示例
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBInstanceSecurityGroups
<公共请求参数>
{
"InstanceId": "crs-eb2w7dto",
"Product": "redis",
"SecurityGroupIds": [
"sg-ajr1jzgj"
]
}
输出示例
{
"Response": {
"RequestId": "1a42feb9-82087f71-6a0031ac-699a92a1"
}
}
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.AddInstanceInfoFailed | 实例安全组信息添加失败。 |
FailedOperation.AssociateSecurityGroupsFailed | 绑定安全组失败。 |
FailedOperation.ClearInstanceInfoFailed | 实例安全组信息清除失败。 |
FailedOperation.DisassociateSecurityGroupsFailed | 解绑安全组失败。 |
FailedOperation.GetSecurityGroupDetailFailed | 获取安全组详情失败。 |
FailedOperation.SetRuleLocationFailed | 设置规则失败。 |
FailedOperation.UpdateInstanceInfoFailed | 实例安全组信息更新失败。 |
FailedOperation.UpdateSecurityGroupsFailed | 更新安全组失败。 |
InternalError.InstanceOperatePermissionError | 无操作权限。 |
InternalError.ListInstancesError | 获取实例列表出错。 |
InvalidParameter.InstanceSGOverLimitError | 实例安全组超过限制。 |
InvalidParameter.NotSupported | 参数错误,不支持操作。 |
InvalidParameter.PermissionDenied | 接口没有cam权限。 |