克隆安全组

最近更新时间:2025-02-12 02:12:18

我的收藏

1. 接口描述

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

本接口(CloneSecurityGroup)用于根据存量的安全组,克隆创建出同样规则配置的安全组。默认仅克隆安全组及其规则信息,可通过入参开启克隆安全组标签信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CloneSecurityGroup。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
SecurityGroupId String 安全组实例ID,例如sg-33ocnj9n,可通过DescribeSecurityGroups获取。
示例值:sg-4esrjvgl
GroupName String 安全组名称,可任意命名,但不得超过60个字符。未提供参数时,克隆后的安全组名称和SecurityGroupId对应的安全组名称相同。
示例值:demo
GroupDescription String 安全组备注,最多100个字符。未提供参数时,克隆后的安全组备注和SecurityGroupId对应的安全组备注相同。
示例值:demo
ProjectId String 项目ID,默认0。可在qcloud控制台项目管理页面查询到。
示例值:0
RemoteRegion String 源Region,跨地域克隆安全组时,需要传入源安全组所属地域信息,例如:克隆广州的安全组到上海,则这里需要传入广州安全的地域信息:ap-guangzhou。
示例值:ap-guangzhou
Tags.N Array of Tag 指定绑定的标签列表,例如:[{"Key": "city", "Value": "shanghai"}]。
若指定Tags入参且指定IsCloneTags为true,会合并源安全组的标签和新增的标签。
示例值:[{"Key": "city", "Value": "shanghai"}]

3. 输出参数

参数名称 类型 描述
SecurityGroup SecurityGroup 安全组对象。
示例值:{"SecurityGroupId": "sg-4esrjvgl", "TagSet": [], "SecurityGroupName": "demo", "SecurityGroupDesc": "demo", "ProjectId": "0", "CreatedTime": "2020-06-08 14:09:58", "UpdateTime": "2020-06-08 14:09:58", "Region": "ap-guangzhou"}
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 克隆安全组

克隆安全组

输入示例

https://vpc.tencentcloudapi.com/?Action=CloneSecurityGroup
&SecurityGroupId=sg-78ysaex1
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
        "SecurityGroup": {
            "SecurityGroupId": "sg-4esrjvgl",
            "SecurityGroupName": "demo",
            "SecurityGroupDesc": "demo",
            "ProjectId": "0",
            "CreatedTime": "2018-01-13 19:26:33",
            "TagSet": [
                {
                    "Key": "city",
                    "Value": "shanghai"
                }
            ],
            "UpdateTime": "2018-02-13 19:26:33",
            "IsDefault": false
        }
    }
}

示例2 克隆安全组,指定项目ID

克隆安全组,指定项目ID

输入示例

https://vpc.tencentcloudapi.com/?Action=CloneSecurityGroup
&SecurityGroupId=sg-78ysaex1
&ProjectId=1001
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
        "SecurityGroup": {
            "SecurityGroupId": "sg-2edhcclz",
            "SecurityGroupName": "demo",
            "SecurityGroupDesc": "demo",
            "ProjectId": "1001",
            "CreatedTime": "2018-01-13 19:26:33",
            "TagSet": [
                {
                    "Key": "city",
                    "Value": "shanghai"
                }
            ],
            "UpdateTime": "2018-02-13 19:26:33",
            "IsDefault": false
        }
    }
}

示例3 克隆安全组,指定名称和备注

克隆安全组,指定名称和备注

输入示例

https://vpc.tencentcloudapi.com/?Action=CloneSecurityGroup
&SecurityGroupId=sg-78ysaex1
&GroupName=demo
&GroupDescription=demo
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
        "SecurityGroup": {
            "SecurityGroupId": "sg-f42uhpkj",
            "SecurityGroupName": "demo",
            "SecurityGroupDesc": "demo",
            "ProjectId": "0",
            "CreatedTime": "2018-01-13 19:26:33",
            "TagSet": [
                {
                    "Key": "city",
                    "Value": "shanghai"
                }
            ],
            "UpdateTime": "2018-02-13 19:26:33",
            "IsDefault": false
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameterValue 参数取值错误。
InvalidParameterValue.Malformed 入参格式不合法。
InvalidParameterValue.TooLong 无效参数值。参数值太长。
LimitExceeded 超过配额限制。
ResourceNotFound 资源不存在。
UnsupportedOperation.RemoteRegionSgHasReferencedSg 此安全组存在嵌套安全组规则,不支持跨地域克隆。