云服务器绑定安全组-安全组相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： cvm.tencentcloudapi.com 。

本接口 (AssociateSecurityGroups) 用于绑定安全组到指定实例。

实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表操作成功。

说明

多个安全组绑定至实例后，将以绑定顺序作为优先级顺序依次匹配执行。如需调整安全组优先级，请参见调整安全组优先级。

默认接口请求频率限制：10次/秒。

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：AssociateSecurityGroups。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
SecurityGroupIds.N	是	Array of String	要绑定的`安全组ID`，类似sg-efil73jd，只支持绑定单个安全组。示例值：["sg-9id3l839"]
InstanceIds.N	是	Array of String	被绑定的`实例ID`，类似ins-lesecurk，支持指定多个实例，每次请求批量实例的上限为100。示例值：["ins-2zvpghhc","ins-915zrb0p"]

3. 输出参数

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

4. 示例

示例1 指定多个实例绑定一个安全组

输入示例

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

{
    "InstanceIds": [
        "ins-915zrb0p",
        "ins-2zvpghhc"
    ],
    "SecurityGroupIds": [
        "sg-9id3l839"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "3385dcf2-e1f0-4ed8-a924-c296721ab65f"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.SecurityGroupActionFailed	安全组操作失败。
InvalidInstanceId.Malformed	无效实例`ID`。指定的实例`ID`格式错误。例如实例`ID`长度错误`ins-1122`。
InvalidInstanceId.NotFound	没有找到相应实例。
InvalidParameterValue.InstanceIdMalformed	实例ID不合要求，请提供规范的实例ID，类似ins-xxxxxxxx，字母x代表小写字符或数字。
InvalidParameterValue.LimitExceeded	参数值数量超过限制。
InvalidSecurityGroupId.NotFound	指定的`安全组ID`不存在。
InvalidSgId.Malformed	指定的`安全组ID`格式错误，例如`实例ID`长度错误`sg-ide32`。
LimitExceeded.AssociateUSGLimitExceeded	一个实例绑定安全组数量不能超过5个
LimitExceeded.CvmsVifsPerSecGroupLimitExceeded	安全组关联云主机弹性网卡配额超限。
LimitExceeded.SingleUSGQuota	安全组限额不足
MutexOperation.TaskRunning	同样的任务正在运行。
OperationDenied.InstanceOperationInProgress	实例正在执行其他操作，请稍后再试。
SecGroupActionFailure	安全组服务接口调用通用错误。
UnsupportedOperation.InstanceStateIsolating	请求不支持正在隔离状态的实例。
UnsupportedOperation.InstanceStatePending	请求不支持创建未完成的实例

绑定安全组

本页目录：