{ "name": "vpc", "display_name": "私有网络", "description": "介绍如何使用API对私有网络进行操作，包括带宽包、IPV6转换服务、安全组、弹性网卡等。", "domain": "network", "api_version": "2017-03-12", "endpoint": "vpc.tencentcloudapi.com", "actions": [ { "name": "AcceptAttachCcnInstances", "description": "本接口（AcceptAttachCcnInstances）用于跨账号关联实例时，云联网所有者接受并同意关联操作。", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "CCN实例ID。形如：ccn-f49l6u0z。", "example": "ccn-gree226l" }, { "name": "Instances", "type": "array", "required": true, "description": "接受关联实例列表。", "example": "[{'InstanceType': 'VPC', 'InstanceId': 'vpc-rkxd3pgh', 'InstanceRegion': 'ap-guangzhou'}]", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "关联实例ID。", "example": "vpc-lt6ork07" }, { "name": "InstanceRegion", "type": "string", "required": true, "description": "关联实例ID所属大区，例如：ap-guangzhou。", "example": "ap-guangzhou" }, { "name": "InstanceType", "type": "string", "required": true, "description": "关联实例类型，可选值： `VPC`：私有网络 `DIRECTCONNECT`：专线网关 `BMVPC`：黑石私有网络 `VPNGW`：VPNGW类型", "example": "VPC" }, { "name": "Description", "type": "string", "required": false, "description": "备注", "example": "remark" }, { "name": "RouteTableId", "type": "string", "required": false, "description": "实例关联的路由表ID。", "example": "ccnrtb-1234edfr" }, { "name": "OrderType", "type": "string", "required": false, "description": "实例付费方式", "example": "PayByCcnOwner" } ] } ], "required": [ "CcnId", "Instances" ] }, { "name": "AcceptVpcPeeringConnection", "description": "本接口（AcceptVpcPeeringConnection）用于接受对等连接请求。", "status": "online", "parameters": [ { "name": "PeeringConnectionId", "type": "string", "required": true, "description": "对等连接唯一ID。", "example": " pcx-0npfx81k" } ], "required": [ "PeeringConnectionId" ] }, { "name": "AddBandwidthPackageResources", "description": "接口用于添加带宽包资源，包括[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)和[负载均衡](https://cloud.tencent.com/document/product/214/517)等", "status": "online", "parameters": [ { "name": "ResourceIds", "type": "array", "required": true, "description": "资源唯一ID，当前支持EIP资源和LB资源，形如'eip-xxxx', 'lb-xxxx'。EIP资源列表可通过[DescribeAddresses](https://cloud.tencent.com/document/product/215/16702)接口获取，LB资源列表可通过[DescribeLoadBalancers](https://cloud.tencent.com/document/api/214/30685)接口获取。", "example": "[\"eip-pez0oibs\"]", "item_type": "string" }, { "name": "BandwidthPackageId", "type": "string", "required": false, "description": "带宽包唯一标识ID，形如'bwp-xxxx'，可以使用[DescribeBandwidthPackages](https://cloud.tencent.com/document/product/215/19209)接口查询BandwidthPackageId。", "example": "bwp-e40edw8y" }, { "name": "NetworkType", "type": "string", "required": false, "description": "带宽包类型，可选值： BGP: 普通BGP共享带宽包 HIGH_QUALITY_BGP: 精品BGP共享带宽包 ANYCAST：公网加速带宽包 SINGLEISP_CMCC: 中国移动共享带宽包 SINGLEISP_CTCC: 中国电信共享带宽包 SINGLEISP_CUCC: 中国联通共享带宽包", "example": "BGP" }, { "name": "ResourceType", "type": "string", "required": false, "description": "资源类型，可选值： Address：弹性公网IP LoadBalance：负载均衡", "example": "Address" }, { "name": "Protocol", "type": "string", "required": false, "description": "带宽包协议类型。当前支持'ipv4'和'ipv6'协议类型。", "example": "ipv4" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "用于带宽包内添加IP资源时指定IP带宽值。说明：当前功能处于内测中，如需使用，请提交[工单申请](https://console.cloud.tencent.com/workorder/category)。", "example": "100" } ], "required": [ "ResourceIds" ] }, { "name": "AddIp6Rules", "description": "1. 该接口用于在转换实例下添加IPV6转换规则。 2. 支持在同一个转换实例下批量添加转换规则，一个账户在一个地域最多50个。 3. 一个完整的转换规则包括vip6:vport6:protocol:vip:vport，其中vip6:vport6:protocol必须是唯一。", "status": "online", "parameters": [ { "name": "Ip6TranslatorId", "type": "string", "required": true, "description": "IPV6转换实例唯一ID，形如ip6-xxxxxxxx", "example": "ip6-90pt7p9q" }, { "name": "Ip6RuleInfos", "type": "array", "required": true, "description": "IPV6转换规则信息", "example": "无", "item_type": "object", "children": [ { "name": "Vport6", "type": "integer", "required": true, "description": "IPV6端口号，可在0~65535范围取值", "example": "80" }, { "name": "Protocol", "type": "string", "required": true, "description": "协议类型，支持TCP/UDP", "example": "TCP" }, { "name": "Vip", "type": "string", "required": true, "description": "IPV4地址", "example": "172.0.0.0" }, { "name": "Vport", "type": "integer", "required": true, "description": "IPV4端口号，可在0~65535范围取值", "example": "80" } ] }, { "name": "Ip6RuleName", "type": "string", "required": false, "description": "IPV6转换规则名称", "example": "\"IPv6 Rule1\"" } ], "required": [ "Ip6TranslatorId", "Ip6RuleInfos" ] }, { "name": "AddTemplateMember", "description": "增加模板对象中的IP地址、协议端口、IP地址组、协议端口组。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "参数模板实例ID，支持IP地址、协议端口、IP地址组、协议端口组四种参数模板的实例ID。", "example": "ipm-88t6207k" }, { "name": "TemplateMember", "type": "array", "required": true, "description": "需要添加的参数模板成员信息，支持IP地址、协议端口、IP地址组、协议端口组四种类型，类型需要与TemplateId参数类型一致。", "example": "[{\"Member\": \"10.0.0.11\"}]", "item_type": "object", "children": [ { "name": "Member", "type": "string", "required": true, "description": "模板对象成员", "example": "ipm-h0fk8lfc" }, { "name": "Description", "type": "string", "required": false, "description": "模板对象成员描述信息", "example": "demo" } ] } ], "required": [ "TemplateId", "TemplateMember" ] }, { "name": "AdjustPublicAddress", "description": "本接口 (AdjustPublicAddress) 用于更换IP地址，支持更换CVM实例的普通公网IP和包月带宽的EIP。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "标识CVM实例的唯一 ID。CVM 唯一 ID 形如：`ins-11112222`。", "example": "ins-11112222" }, { "name": "AddressId", "type": "string", "required": false, "description": "标识EIP实例的唯一 ID。EIP 唯一 ID 形如：`eip-11112222`。", "example": "eip-11112222" } ], "required": [] }, { "name": "AllocateAddresses", "description": "本接口 (AllocateAddresses) 用于申请一个或多个[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)（简称 EIP）。 * EIP 是专为动态云计算设计的静态 IP 地址。借助 EIP，您可以快速将 EIP 重新映射到您的另一个实例上，从而屏蔽实例故障。 * 您的 EIP 与腾讯云账户相关联，而不是与某个实例相关联。在您选择显式释放该地址，或欠费超过24小时之前，它会一直与您的腾讯云账户保持\ufffd...", "status": "online", "parameters": [ { "name": "AddressCount", "type": "integer", "required": false, "description": "EIP数量。可申请的数量限制参考：[EIP 配额限制](https://cloud.tencent.com/document/product/1199/41648)。默认值：1。", "example": "1" }, { "name": "InternetServiceProvider", "type": "string", "required": false, "description": "EIP线路类型。各种线路类型详情可参考：[EIP 的 IP 地址类型](https://cloud.tencent.com/document/product/1199/41646)。默认值：BGP。 BGP：常规 BGP 线路 已开通静态单线IP白名单的用户，可选值：CMCC：中国移动 CTCC：中国电信 CUCC：中国联通注意：仅部分地域支持静态单线IP。", "example": "BGP" }, { "name": "InternetChargeType", "type": "string", "required": false, "description": "EIP计费方式。 标准账户类型，可选值：BANDWIDTH_PACKAGE：[共享带宽包](https://cloud.tencent.com/document/product/684/15255)付费 BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费 BANDWIDTH_PREPAID_BY_MONTH：包月按带宽预付费 TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费默认值：TRAFFIC_POSTPAID_BY_HOUR。 传统账户类型，无需传递此参数，EIP计费方式与其绑定的实例的计费方式一致，无需传递此参数。", "example": "TRAFFIC_POSTPAID_BY_HOUR" }, { "name": "IPChargeType", "type": "string", "required": false, "description": "IP 资源计费模式，当前仅支持原生 IP。 账号为标准账户类型的用户，可选值：IP_POSTPAID_BY_HOUR：IP资源按小时后付费IP_PREPAID_BY_MONTH：IP资源包月预付费", "example": "IP_POSTPAID_BY_HOUR" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "EIP出带宽上限，单位：Mbps。 标准账户类型EIP出带宽上限，可选值范围取决于EIP计费方式：BANDWIDTH_PACKAGE：1 Mbps 至 2000 Mbps BANDWIDTH_POSTPAID_BY_HOUR：1 Mbps 至 100 Mbps BANDWIDTH_PREPAID_BY_MONTH：1 Mbps 至 200 Mbps TRAFFIC_POSTPAID_BY_HOUR：1 Mbps 至 100 Mbps默认值：1 Mbps。 传统账户类型无需传递此参数，EIP出带宽上限取决于与其绑定的实例的公网出带宽上限，无需传递此参数。", "example": "10" }, { "name": "AddressChargePrepaid", "type": "object", "required": false, "description": "包月按带宽预付费EIP的计费参数。EIP为包月按带宽预付费时，该参数必传，其余场景不需传递", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位是月。可支持时长：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36", "example": "12" }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "自动续费标志。0表示手动续费，1表示自动续费，2表示到期不续费。默认缺省为1即自动续费。", "example": "2" } ] }, { "name": "AddressType", "type": "string", "required": false, "description": "EIP类型。各种EIP类型详情可参考：[EIP 的 IP 地址类型](https://cloud.tencent.com/document/product/1199/41646)。默认值：EIP。 EIP：弹性公网 IP。 AnycastEIP：加速 IP，已开通 [Anycast 公网加速](https://cloud.tencent.com/document/product/644)白名单的用户可选。仅部分地域支持加速IP，详情可见Anycast公网加速[购买指南](https://cloud.tencent.com/document/product/644/12617)。 HighQualityEIP：精品 IP。仅新加坡和中国香港支\ufffd\ufffd...", "example": "AnycastEIP" }, { "name": "AnycastZone", "type": "string", "required": false, "description": "Anycast发布域。 已开通Anycast公网加速白名单的用户，可选值：ANYCAST_ZONE_GLOBAL：全球发布域（需要额外开通Anycast全球加速白名单）ANYCAST_ZONE_OVERSEAS：境外发布域默认值：ANYCAST_ZONE_OVERSEAS。", "example": "ANYCAST_ZONE_A" }, { "name": "VipCluster", "type": "array", "required": false, "description": "指定IP地址申请EIP，每个账户每个月只有三次配额", "example": "[\"1.1.1.1\"]", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "需要关联的标签列表。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] }, { "name": "BandwidthPackageId", "type": "string", "required": false, "description": "BGP带宽包唯一ID参数。设定该参数且InternetChargeType为BANDWIDTH_PACKAGE，则表示创建的EIP加入该BGP带宽包并采用带宽包计费", "example": "bwp-6jnvlsv4" }, { "name": "AddressName", "type": "string", "required": false, "description": "EIP名称，用于申请EIP时用户自定义该EIP的个性化名称，默认值：未命名", "example": "demo" }, { "name": "DedicatedClusterId", "type": "string", "required": false, "description": "CDC唯一ID", "example": "cluster-gbo27yc4" }, { "name": "IsDedicatedAddressPool", "type": "boolean", "required": false, "description": "是否使用独占资源池，默认值：True - True：表示使用独占资源池 - False：表示使用共享资源池 说明：如需使用独占资源池，请 提交工单(https://console.cloud.tencent.com/workorder/category) 咨询，具体费用请咨询商务经理。", "example": "false" }, { "name": "Egress", "type": "string", "required": false, "description": "网络出口，当前仅支持精品BGP、静态单线，这2种IP 地址类型的指定出口传入，默认值：center_egress1，其它可选值：center_egress2、center_egress3", "example": "center_egress1" }, { "name": "AntiDDoSPackageId", "type": "string", "required": false, "description": "高防包ID， 申请高防IP时，该字段必传。", "example": "bgp-12345678" }, { "name": "ClientToken", "type": "string", "required": false, "description": "保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。", "example": "123e4567-e89b-12d3-a456-426655440000" } ], "required": [] }, { "name": "AllocateIPv6Addresses", "description": "本接口（AllocateIPv6Addresses）用于申请一个或多个弹性公网IPv6（简称EIPv6）实例。 - EIPv6 是您在腾讯云某个地域可以独立申请和持有的，固定不变的公网 IPv6 地址，提供与弹性公网 IPv4 一致的产品体验。 - 通过弹性公网 IPv6，您可以快速将 EIPv6 实例绑定到云资源的内网 IPv6 地址上，实现为云资源快速开通 IPv6 公网带宽。 - 您还可以按需将 EIPv6 实例绑定到其他云资源上，从而屏蔽\ufffd...", "status": "online", "parameters": [ { "name": "AddressName", "type": "string", "required": false, "description": "EIP名称，用于申请EIP时用户自定义该EIP的个性化名称。长度上限为128个字符，允许使用大小写字母、汉字、数字、连字符\"-\"和下划线\"_\"，不能包含空格。 默认值：未命名", "example": "demo" }, { "name": "AddressType", "type": "string", "required": false, "description": "弹性公网IPv6类型，可选值： - EIPv6：弹性公网IPv6 - HighQualityEIPv6：精品BGP线路弹性公网IPv6 注意：弹性公网IPv6产品需开白才能使用，其中精品BGP线路仅在中国香港支持。 默认值：EIPv6", "example": "EIPv6" }, { "name": "AddressCount", "type": "integer", "required": false, "description": "申请的弹性公网IPv6数量。单次最多可以申请20个弹性公网IPv6实例，总配额请参见[弹性公网 IPv6 配额说明](https://cloud.tencent.com/document/product/1142/38369)。 默认值：1", "example": "1" }, { "name": "InternetChargeType", "type": "string", "required": false, "description": "弹性公网IPv6计费方式，可选值： - BANDWIDTH_PACKAGE：[共享带宽包](https://cloud.tencent.com/document/product/684/15255)付费 - TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费 默认值：TRAFFIC_POSTPAID_BY_HOUR", "example": "TRAFFIC_POSTPAID_BY_HOUR" }, { "name": "InternetServiceProvider", "type": "string", "required": false, "description": "弹性公网IPv6线路类型，默认值：BGP。 已开通静态单线IP白名单的用户，可选值： - CMCC：中国移动 - CTCC：中国电信 - CUCC：中国联通 注意：仅部分地域支持静态单线IP。具体请以控制台购买页展示为准。", "example": "BGP" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "弹性公网IPv6带宽上限，单位：Mbps。 可选值范围取决于EIP计费方式： - BANDWIDTH_PACKAGE（共享带宽包付费）：1 Mbps 至 2000 Mbps - TRAFFIC_POSTPAID_BY_HOUR（流量按小时后付费）：1 Mbps 至 100 Mbps 默认值：1", "example": "10" }, { "name": "BandwidthPackageId", "type": "string", "required": false, "description": "带宽包唯一ID参数。可以使用[DescribeBandwidthPackages](https://cloud.tencent.com/document/product/215/19209)接口查询BandwidthPackageId。 设定该参数且InternetChargeType为BANDWIDTH_PACKAGE，则表示创建的EIP加入该BGP带宽包并采用带宽包计费。", "example": "bwp-6jnvlsv4" }, { "name": "Tags", "type": "array", "required": false, "description": "需要关联的标签列表。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] }, { "name": "Egress", "type": "string", "required": false, "description": "弹性公网IPv6网络出口，可选值： - CENTER_EGRESS_1：中心出口一 - CENTER_EGRESS_2：中心出口二 注意：不同地域支持的线路类型、网络出口略有差异，请以控制台展示为准。 默认值：CENTER_EGRESS_1", "example": "center_egress1" } ], "required": [] }, { "name": "AllocateIp6AddressesBandwidth", "description": "本接口（AllocateIp6AddressesBandwidth）用于为传统弹性公网 IPv6 地址开通 IPv6 公网带宽。 - 传统弹性公网 IPv6 地址默认仅具备内网通信能力，需通过控制台或 API 接口为其分配公网带宽后，才能具备 IPv6 公网通信能力、并于传统弹性公网 IPv6 列表页可见。 - 支持为一个或多个传统弹性公网 IPv6 实例开通公网带宽。", "status": "online", "parameters": [ { "name": "Ip6Addresses", "type": "array", "required": true, "description": "需要开通公网访问能力的IPv6地址，可以使用[DescribeIp6Addresses](https://cloud.tencent.com/document/product/215/40089)接口查询Ip6Addresses。", "example": "[\"2402:4e00:1011:9b02:0:98e8:f0fd:3a85\"]", "item_type": "string" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "带宽上限，单位Mbps。可调整的带宽上限值参考产品文档中[IPv6 计费限制说明](https://cloud.tencent.com/document/product/1142/38369#IPv6)。 默认值：1Mbps", "example": "50" }, { "name": "InternetChargeType", "type": "string", "required": false, "description": "网络计费模式。IPv6当前支持：TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费BANDWIDTH_PACKAGE：共享带宽包付费 默认值：TRAFFIC_POSTPAID_BY_HOUR", "example": "TRAFFIC_POSTPAID_BY_HOUR" }, { "name": "BandwidthPackageId", "type": "string", "required": false, "description": "带宽包id，设定该参数且InternetChargeType为BANDWIDTH_PACKAGE，则表示创建的IPv6加入该带宽包并采用带宽包计费。可以使用[DescribeBandwidthPackages](https://cloud.tencent.com/document/product/215/19209)接口查询BandwidthPackageId。", "example": "bwp-12345678" }, { "name": "Tags", "type": "array", "required": false, "description": "需要关联的标签列表。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] } ], "required": [ "Ip6Addresses" ] }, { "name": "AssignIpv6Addresses", "description": "本接口（AssignIpv6Addresses）用于弹性网卡申请`IPv6`地址。 本接口是异步完成，如需查询异步任务执行结果，请使用本接口返回的`RequestId`轮询[DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037)接口。 * 一个弹性网卡支持绑定的IP地址是有限制的，更多资源限制信息详见弹性网卡使用限制。 * 可以指定`IPv6`地址申请，地址类型不能为主`IP`，`IPv6`地址暂时只支持作为辅助`IP`。 *...", "status": "online", "parameters": [ { "name": "NetworkInterfaceId", "type": "string", "required": true, "description": "弹性网卡实例`ID`，形如：`eni-m6dyj72l`。可通过[DescribeNetworkInterfaces](https://cloud.tencent.com/document/product/215/15817)接口获取。", "example": "eni-5u5biujl" }, { "name": "Ipv6Addresses", "type": "array", "required": false, "description": "指定的`IPv6`地址列表，单次最多指定10个。与入参`Ipv6AddressCount`合并计算配额。与Ipv6AddressCount必填一个。", "example": "[{\"Address\":\"3402:4e00:20:1202:0:8d05:c272:f514\"}]", "item_type": "object", "children": [ { "name": "Address", "type": "string", "required": true, "description": "`IPv6`地址，形如：`3402:4e00:20:100:0:8cd9:2a67:71f3`", "example": "3402:4e00:20:1202::1" }, { "name": "Primary", "type": "boolean", "required": false, "description": "是否是主`IP`。", "example": "false" }, { "name": "AddressId", "type": "string", "required": false, "description": "`EIP`实例`ID`，形如：`eip-hxlqja90`。作为入参数时，可通过[DescribeAddresses](https://cloud.tencent.com/document/product/215/16702)接口获取。", "example": "eip-5k6fot41" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息。", "example": "demo" }, { "name": "IsWanIpBlocked", "type": "boolean", "required": false, "description": "公网IP是否被封堵。", "example": "false" }, { "name": "State", "type": "string", "required": false, "description": "`IPv6`地址状态： `PENDING`：生产中 `MIGRATING`：迁移中 `DELETING`：删除中 `AVAILABLE`：可用的", "example": "AVAILABLE" }, { "name": "PublicIpAddress", "type": "string", "required": false, "description": "如果 IPv6地址是 ULA 类型，绑定的公网IP地址。", "example": "3402:4e00:20:1202::2" }, { "name": "AddressType", "type": "string", "required": false, "description": "`IPv6`地址的类型: `GUA`(全球单播地址), `ULA`(唯一本地地址)", "example": "ULA" } ] }, { "name": "Ipv6AddressCount", "type": "integer", "required": false, "description": "自动分配`IPv6`地址个数，内网IP地址个数总和不能超过配额数。与入参`Ipv6Addresses`合并计算配额。与Ipv6Addresses必填一个。", "example": "1" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "d7df28fd-dcba-4dbb-82bc-bce3bf4d3562" } ], "required": [ "NetworkInterfaceId" ] }, { "name": "AssignIpv6CidrBlock", "description": "本接口（AssignIpv6CidrBlock）用于分配IPv6网段。 * 使用本接口前，您需要已有VPC实例，如果没有可通过接口CreateVpc创建。 * 每个VPC只能申请一个IPv6网段。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "`VPC`实例`ID`，形如：`vpc-f49l6u0z`。", "example": "vpc-5k6fot41" }, { "name": "AddressType", "type": "string", "required": false, "description": "申请IPv6 Cidr 的类型，`GUA`(全球单播地址), `ULA`(唯一本地地址)。", "example": "GUA" } ], "required": [ "VpcId" ] }, { "name": "AssignIpv6SubnetCidrBlock", "description": "本接口（AssignIpv6SubnetCidrBlock）用于分配IPv6子网段。 * 给子网分配 `IPv6` 网段，要求子网所属 `VPC` 已获得 `IPv6` 网段。如果尚未分配，请先通过接口 `AssignIpv6CidrBlock` 给子网所属 `VPC` 分配一个 `IPv6` 网段。否则无法分配 `IPv6` 子网段。 * 每个子网只能分配一个IPv6网段。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "子网所在私有网络`ID`。形如：`vpc-f49l6u0z`。", "example": "vpc-5k6fot41" }, { "name": "Ipv6SubnetCidrBlocks", "type": "array", "required": true, "description": "分配 `IPv6` 子网段列表。", "example": "{ \"SubnetId\": \"subnet-5k6fot41\", \"Ipv6CidrBlock\": \"2402:4e00:1717:8700::/64\" }", "item_type": "object", "children": [ { "name": "SubnetId", "type": "string", "required": true, "description": "子网实例`ID`。形如：`subnet-pxir56ns`。", "example": "subnet-kgpu7qt2" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "`IPv6`子网段。形如：`3402:4e00:20:1001::/64`。作为AssignIpv6SubnetCidrBlock接口入参时，该参数必填。", "example": "3402:4e00:20:1202::/64" } ] }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "d7df28fd-dcba-4dbb-82bc-bce3bf4d3562" } ], "required": [ "VpcId", "Ipv6SubnetCidrBlocks" ] }, { "name": "AssignPrivateIpAddresses", "description": "本接口（AssignPrivateIpAddresses）用于弹性网卡申请内网 IP。 * 一个弹性网卡支持绑定的IP地址是有限制的，更多资源限制信息详见弹性网卡使用限制。 * 可以指定内网IP地址申请，内网IP地址类型不能为主IP，主IP已存在，不能修改，内网IP必须要在弹性网卡所在子网内，而且不能被占用。 * 在弹性网卡上申请一个到多个辅助内网IP，接口会在弹性网卡所在子网网段内返回指定数量的...", "status": "online", "parameters": [ { "name": "NetworkInterfaceId", "type": "string", "required": true, "description": "弹性网卡实例ID，例如：eni-m6dyj72l。可通过[DescribeNetworkInterfaces](https://cloud.tencent.com/document/product/215/15817)接口获取。", "example": "eni-afo43z61" }, { "name": "PrivateIpAddresses", "type": "array", "required": false, "description": "指定的内网IP信息，单次最多指定10个。与SecondaryPrivateIpAddressCount至少提供一个。", "example": "无", "item_type": "object", "children": [ { "name": "PrivateIpAddress", "type": "string", "required": false, "description": "内网IP地址。", "example": "192.168.0.10" }, { "name": "Primary", "type": "boolean", "required": false, "description": "是否是主IP。", "example": "false" }, { "name": "PublicIpAddress", "type": "string", "required": false, "description": "公网IP地址。", "example": "123.10.100.171" }, { "name": "AddressId", "type": "string", "required": false, "description": "EIP实例ID，例如：eip-11112222。", "example": "eip-29mdigub" }, { "name": "Description", "type": "string", "required": false, "description": "内网IP描述信息。", "example": "demo" }, { "name": "IsWanIpBlocked", "type": "boolean", "required": false, "description": "公网IP是否被封堵。", "example": "false" }, { "name": "State", "type": "string", "required": false, "description": "IP状态： PENDING：生产中 MIGRATING：迁移中 DELETING：删除中 AVAILABLE：可用的", "example": "AVAILABLE" }, { "name": "QosLevel", "type": "string", "required": false, "description": "IP服务质量等级，可选值：PT（云金）、AU（云银）、AG(云铜）、DEFAULT（默认）。", "example": "PT" } ] }, { "name": "SecondaryPrivateIpAddressCount", "type": "integer", "required": false, "description": "新申请的内网IP地址个数，与PrivateIpAddresses至少提供一个。内网IP地址个数总和不能超过配额数，详见弹性网卡使用限制。", "example": "2" }, { "name": "QosLevel", "type": "string", "required": false, "description": "IP服务质量等级，和SecondaryPrivateIpAddressCount配合使用，可选值：PT（云金）、AU（云银）、AG(云铜）、DEFAULT（默认）。", "example": "PT" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "d7df28fd-dcba-4dbb-82bc-bce3bf4d3562" } ], "required": [ "NetworkInterfaceId" ] }, { "name": "AssociateAddress", "description": "本接口 (AssociateAddress) 用于将[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)（简称 EIP）绑定到实例或弹性网卡的指定内网 IP 上。 * 将 EIP 绑定到实例（CVM）上，其本质是将 EIP 绑定到实例上主网卡的主内网 IP 上。 * 将 EIP 绑定到主网卡的主内网IP时，如主内网IP已绑定普通公网IP，必须先退还才能绑定EIP。 * 将 EIP 绑定到指定网卡的内网 IP上（非主网卡的主内网IP），则必\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "AddressId", "type": "string", "required": true, "description": "标识 EIP 的唯一 ID。可以使用[DescribeAddresses](https://cloud.tencent.com/document/product/215/16702)接口获取AddressId。EIP 唯一 ID 形如：`eip-11112222`。", "example": "eip-ek0cdz1g" }, { "name": "InstanceId", "type": "string", "required": false, "description": "要绑定的实例 ID。实例 ID 形如：`ins-11112222`、`lb-11112222`。可通过登录[控制台](https://console.cloud.tencent.com/cvm)查询，也可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口返回值中的`InstanceId`获取。", "example": "ins-1bmpb9tu" }, { "name": "NetworkInterfaceId", "type": "string", "required": false, "description": "要绑定的弹性网卡 ID。 弹性网卡 ID 形如：`eni-11112222`。`NetworkInterfaceId` 与 `InstanceId` 不可同时指定。弹性网卡 ID 可通过登录[控制台](https://console.cloud.tencent.com/vpc/eni)查询，也可通过[DescribeNetworkInterfaces](https://cloud.tencent.com/document/api/215/15817)接口返回值中的`networkInterfaceId`获取。", "example": "eni-jyhoxx61" }, { "name": "PrivateIpAddress", "type": "string", "required": false, "description": "要绑定的内网 IP。如果指定了 `NetworkInterfaceId` 则也必须指定 `PrivateIpAddress` ，表示将 EIP 绑定到指定弹性网卡的指定内网 IP 上。同时要确保指定的 `PrivateIpAddress` 是指定的 `NetworkInterfaceId` 上的一个内网 IP。指定弹性网卡的内网 IP 可通过登录[控制台](https://console.cloud.tencent.com/vpc/eni)查询，也可通过[DescribeNetworkInterfaces](https://cloud.tencent.com/document/api/215/15817)接口返回值中的`privateIpA...", "example": "10.0.0.120" }, { "name": "EipDirectConnection", "type": "boolean", "required": false, "description": "指定绑定时是否设置直通。弹性公网 IP 直通请参见 [EIP 直通](https://cloud.tencent.com/document/product/1199/41709)。取值：true、false，默认值为 false。当绑定 CVM 实例、EKS 弹性集群时，可设定此参数为 true。此参数目前处于内测中，如需使用，请提交 [工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=6\u0026level2_id=163\u0026source=0\u0026data_title=%E8%B4%9F%E8%BD%BD%E5%9D%87%E8%A1%A1%20CLB\u0026level3_id=1071\u0026queue=96\u0026scen...", "example": "false" }, { "name": "InstanceRegion", "type": "string", "required": false, "description": "要绑定的实例所在地域。默认无需填写，仅限GAAP特殊场景需指定实例所在地域。", "example": "ap-guangzhou" } ], "required": [ "AddressId" ] }, { "name": "AssociateDhcpIpWithAddressIp", "description": "本接口（AssociateDhcpIpWithAddressIp）用于DhcpIp绑定弹性公网IP（EIP）。 \u003e?本接口为异步接口，可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果，待任务执行成功后再进行其他操作。 \u003e", "status": "online", "parameters": [ { "name": "DhcpIpId", "type": "string", "required": true, "description": "`DhcpIp`唯一`ID`，形如：`dhcpip-9o233uri`。必须是没有绑定`EIP`的`DhcpIp`", "example": "dpcpip-9o233uri" }, { "name": "AddressIp", "type": "string", "required": true, "description": "弹性公网`IP`。必须是没有绑定`DhcpIp`的`EIP`", "example": "119.29.93.218" } ], "required": [ "DhcpIpId", "AddressIp" ] }, { "name": "AssociateDirectConnectGatewayNatGateway", "description": "将专线网关与NAT网关绑定，专线网关默认路由指向NAT网关", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC实例ID。形如：vpc-xxx。", "example": "vpc-8xpno8ee" }, { "name": "NatGatewayId", "type": "string", "required": true, "description": "NAT网关ID。形如：nat-xxx", "example": "nat-ig8xpno8" }, { "name": "DirectConnectGatewayId", "type": "string", "required": true, "description": "专线网关ID。形如：dcg-xxx", "example": "dcg-fxa6gh5t" } ], "required": [ "VpcId", "NatGatewayId", "DirectConnectGatewayId" ] }, { "name": "AssociateHaVipInstance", "description": "本接口（AssociateHaVipInstance）用于HAVIP绑定子机或网卡（限制HaVip的漂移范围）。", "status": "online", "parameters": [ { "name": "HaVipAssociationSet", "type": "array", "required": true, "description": "HaVip绑定的子机或网卡。最多支持10个实例。", "example": "无", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "HaVip绑定的子机或网卡唯一ID。", "example": "ins-3qx9elib" }, { "name": "HaVipId", "type": "string", "required": false, "description": "HaVip实例唯一ID。", "example": "havip-7tqt5jn6" }, { "name": "InstanceType", "type": "string", "required": false, "description": "HaVip绑定的类型。取值:CVM, ENI。", "example": "CVM" } ] } ], "required": [ "HaVipAssociationSet" ] }, { "name": "AssociateIPv6Address", "description": "本接口（AssociateIPv6Address）用于将弹性公网IPv6（简称EIPv6）实例绑定到 CVM 或弹性网卡配置的内网 IPv6 地址上。 - 将 EIPv6 绑定到 CVM 上，其本质是将 EIPv6 绑定到 CVM 弹性网卡所配置的内网 IPv6 地址上。 - 将 EIPv6 绑定到指定网卡的内网 IPv6 时，需确保该内网 IPv6 地址为未绑定状态，才能执行绑定操作。", "status": "online", "parameters": [ { "name": "IPv6AddressId", "type": "string", "required": true, "description": "弹性公网IPv6唯一ID，EIPv6 唯一 ID 形如：eipv6-11112222。可以使用[DescribeIPv6Addresses](https://cloud.tencent.com/document/api/215/113677)接口获取IPv6AddressId。", "example": "eipv6-nzvwsush" }, { "name": "InstanceId", "type": "string", "required": false, "description": "要绑定的实例 ID。实例 ID 形如：ins-djflxkvi。可通过登录控制台查询，也可通过 DescribeInstances 接口返回值中的InstanceId获取。", "example": "ins-kfowxcv8" }, { "name": "NetworkInterfaceId", "type": "string", "required": false, "description": "要绑定的弹性网卡 ID。 弹性网卡 ID 形如：eni-11112222。NetworkInterfaceId 与 InstanceId 不可同时指定。弹性网卡 ID 可通过登录[控制台](https://console.cloud.tencent.com/vpc/eni?rid=1)查询，也可通过[DescribeNetworkInterfaces](https://cloud.tencent.com/document/api/215/15817)接口返回值中的networkInterfaceId获取。", "example": "eni-jyhoxx61" }, { "name": "PrivateIPv6Address", "type": "string", "required": false, "description": "要绑定的内网 IPv6。如果指定了 NetworkInterfaceId 则也必须指定 PrivateIPv6Address ，表示将 EIP 绑定到指定弹性网卡的指定内网 IP 上。同时要确保指定的 PrivateIPv6Address 是指定的 NetworkInterfaceId 上的一个内网 IPv6。指定弹性网卡的内网 IPv6 可通过登录[控制台](https://console.cloud.tencent.com/vpc/eni?rid=1)查询，也可通过[DescribeNetworkInterfaces](https://cloud.tencent.com/document/api/215/15817)接口返回值中的Ipv...", "example": "fc00:200:300:700:0:9c64:2c95:b711" } ], "required": [ "IPv6AddressId" ] }, { "name": "AssociateInstancesToCcnRouteTable", "description": "本接口（AssociateInstancesToCcnRouteTable）用于将指定的云联网实例关联到指定的云联网路由表。", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "云联网ID。", "example": "ccn-1223cdfe" }, { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表ID。", "example": "ccnrtb-1234edfr" }, { "name": "Instances", "type": "array", "required": true, "description": "实例列表。", "example": "无", "item_type": "object", "children": [ { "name": "InstanceType", "type": "string", "required": true, "description": "云联网支持的实例类型： `VPC` `DIRECTCONNECT` `BMVPC` `EDGE` `EDGE_TUNNEL` `EDGE_VPNGW` `VPNGW`", "example": "VPC" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "vpc-m0c2kcun" } ] } ], "required": [ "CcnId", "RouteTableId", "Instances" ] }, { "name": "AssociateNatGatewayAddress", "description": "本接口(AssociateNatGatewayAddress)用于NAT网关绑定弹性IP（EIP）。", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "NAT网关的ID，形如：`nat-df45454`。", "example": "nat-mdbjfr0y" }, { "name": "AddressCount", "type": "integer", "required": false, "description": "需要申请的弹性IP个数，系统会按您的要求生产N个弹性IP, 其中AddressCount和PublicAddresses至少传递一个。", "example": "1" }, { "name": "PublicIpAddresses", "type": "array", "required": false, "description": "绑定NAT网关的弹性IP数组，其中AddressCount和PublicAddresses至少传递一个。", "example": "[\"139.199.232.212\\n\"]", "item_type": "string" }, { "name": "Zone", "type": "string", "required": false, "description": "弹性IP可用区，自动分配弹性IP时传递。 其中产品可用区查询接口为[查询产品可用区列表](https://cloud.tencent.com/document/product/1596/77929)", "example": "10003" }, { "name": "StockPublicIpAddressesBandwidthOut", "type": "integer", "required": false, "description": "绑定NAT网关的弹性IP带宽大小（单位Mbps），默认为当前用户类型所能使用的最大值。", "example": "77" }, { "name": "PublicIpAddressesBandwidthOut", "type": "integer", "required": false, "description": "需要申请公网IP带宽大小（单位Mbps），默认为当前用户类型所能使用的最大值。", "example": "77" }, { "name": "PublicIpFromSameZone", "type": "boolean", "required": false, "description": "公网IP是否强制与NAT网关来自同可用区，true表示需要与NAT网关同可用区；false表示可与NAT网关不是同一个可用区。此参数只有当参数Zone存在时才能生效。", "example": "true" }, { "name": "IpAddressEnableMode", "type": "boolean", "required": false, "description": "启用或者禁用NAT网关绑定的EIP", "example": "true" } ], "required": [ "NatGatewayId" ] }, { "name": "AssociateNetworkAclSubnets", "description": "本接口（AssociateNetworkAclSubnets）用于网络ACL关联VPC下的子网。", "status": "online", "parameters": [ { "name": "NetworkAclId", "type": "string", "required": true, "description": "网络ACL实例ID。例如：acl-12345678。", "example": "acl-12345678" }, { "name": "SubnetIds", "type": "array", "required": true, "description": "子网实例ID数组。例如：[subnet-12345678]。", "example": "[\"subnet-12345678\\r\\n\"]", "item_type": "string" } ], "required": [ "NetworkAclId", "SubnetIds" ] }, { "name": "AssociateNetworkInterfaceSecurityGroups", "description": "本接口（AssociateNetworkInterfaceSecurityGroups）用于弹性网卡绑定安全组（SecurityGroup）。", "status": "online", "parameters": [ { "name": "NetworkInterfaceIds", "type": "array", "required": true, "description": "弹性网卡实例ID。形如：eni-pxir56ns。每次请求的实例的上限为100。本接口不支持主网卡绑定安全组。可通过[DescribeNetworkInterfaces](https://cloud.tencent.com/document/product/215/15817)接口获取。", "example": "[\"eni-1a2b3c4d\"]", "item_type": "string" }, { "name": "SecurityGroupIds", "type": "array", "required": true, "description": "安全组实例ID，例如：sg-33ocnj9n，可通过DescribeSecurityGroups获取。每次请求的实例的上限为100。可通过[DescribeSecurityGroups](https://cloud.tencent.com/document/product/215/15808)接口获取。", "example": "[\"sg-1a2b3c4d\"]", "item_type": "string" } ], "required": [ "NetworkInterfaceIds", "SecurityGroupIds" ] }, { "name": "AttachCcnInstances", "description": "本接口（AttachCcnInstances）用于将网络实例加载到云联网实例中，网络实例包括VPC和专线网关。 每个云联网能够关联的网络实例个数是有限的，详情请参考产品文档。如果需要扩充请联系在线客服。", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "CCN实例ID。形如：ccn-f49l6u0z。", "example": "ccn-gree226l" }, { "name": "Instances", "type": "array", "required": true, "description": "关联网络实例列表", "example": "[{'InstanceType': 'VPC', 'InstanceId': 'vpc-rkxd3pgh', 'InstanceRegion': 'ap-guangzhou'}]", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "关联实例ID。", "example": "vpc-lt6ork07" }, { "name": "InstanceRegion", "type": "string", "required": true, "description": "关联实例ID所属大区，例如：ap-guangzhou。", "example": "ap-guangzhou" }, { "name": "InstanceType", "type": "string", "required": true, "description": "关联实例类型，可选值： `VPC`：私有网络 `DIRECTCONNECT`：专线网关 `BMVPC`：黑石私有网络 `VPNGW`：VPNGW类型", "example": "VPC" }, { "name": "Description", "type": "string", "required": false, "description": "备注", "example": "remark" }, { "name": "RouteTableId", "type": "string", "required": false, "description": "实例关联的路由表ID。", "example": "ccnrtb-1234edfr" }, { "name": "OrderType", "type": "string", "required": false, "description": "实例付费方式", "example": "PayByCcnOwner" } ] }, { "name": "CcnUin", "type": "string", "required": false, "description": "CCN所属UIN（根账号），默认当前账号所属UIN", "example": "700000138273" } ], "required": [ "CcnId", "Instances" ] }, { "name": "AttachClassicLinkVpc", "description": "本接口(AttachClassicLinkVpc)用于创建私有网络和基础网络设备互通。 * 私有网络和基础网络设备必须在同一个地域。 * 私有网络和基础网络的区别详见vpc产品文档-私有网络与基础网络。 \u003e?本接口为异步接口，可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果，待任务执行成功后再进行其他操作。 \u003e", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC实例ID", "example": "vpc-gjui0b5t" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "CVM实例ID", "example": "[\"ins-0x5msjda\"]", "item_type": "string" } ], "required": [ "VpcId", "InstanceIds" ] }, { "name": "AttachNetworkInterface", "description": "本接口（AttachNetworkInterface）用于弹性网卡绑定云服务器。 * 一个弹性网卡请至少绑定一个安全组，如需绑定请参见弹性网卡绑定安全组。 * 一个云服务器可以绑定多个弹性网卡，但只能绑定一个主网卡。更多限制信息详见弹性网卡使用限制。 * 一个弹性网卡只能同时绑定一个云服务器。 * 只有运行中或者已关机状态的云服务器才能绑定弹性网卡，查看云服务器状态详见腾讯云\ufffd...", "status": "online", "parameters": [ { "name": "NetworkInterfaceId", "type": "string", "required": true, "description": "弹性网卡实例ID，例如：eni-m6dyj72l。可通过[DescribeNetworkInterfaces](https://cloud.tencent.com/document/product/215/15817)接口获取。", "example": "eni-m6dyj72l" }, { "name": "InstanceId", "type": "string", "required": true, "description": "CVM实例ID。形如：ins-r8hr2upy。可通过[DescribeInstances](https://cloud.tencent.com/document/product/213/15728)接口获取。", "example": "ins-r8hr2upy" }, { "name": "AttachType", "type": "integer", "required": false, "description": "网卡的挂载类型：0 标准型，1扩展型，默认值0。", "example": "0" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "d7df28fd-dcba-4dbb-82bc-bce3bf4d3562" } ], "required": [ "NetworkInterfaceId", "InstanceId" ] }, { "name": "AttachSnapshotInstances", "description": "本接口（AttachSnapshotInstances）用于快照策略关联实例。", "status": "online", "parameters": [ { "name": "SnapshotPolicyId", "type": "string", "required": true, "description": "快照策略Id。", "example": "sspolicy-hx8an9sr" }, { "name": "Instances", "type": "array", "required": true, "description": "关联实例信息。", "example": "无", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id。", "example": "sg-123zsda" }, { "name": "InstanceType", "type": "string", "required": true, "description": "实例类型，目前支持安全组：securitygroup。", "example": "securitygroup" }, { "name": "InstanceRegion", "type": "string", "required": true, "description": "实例所在地域。", "example": "ap-guangzhou" }, { "name": "SnapshotPolicyId", "type": "string", "required": false, "description": "快照策略Id。", "example": "sspolicy-hx8an9sr" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称。", "example": "名称" } ] } ], "required": [ "SnapshotPolicyId", "Instances" ] }, { "name": "AuditCrossBorderCompliance", "description": "本接口（AuditCrossBorderCompliance）用于服务商操作合规化资质审批。 * 服务商只能操作提交到本服务商的审批单，后台会校验身份。即只授权给服务商的`APPID` 调用本接口。 * `APPROVED` 状态的审批单，可以再次操作为 `DENY`；`DENY` 状态的审批单，也可以再次操作为 `APPROVED`。", "status": "online", "parameters": [ { "name": "ServiceProvider", "type": "string", "required": true, "description": "服务商, 可选值：`UNICOM`。", "example": "UNICOM" }, { "name": "ComplianceId", "type": "integer", "required": true, "description": "表单唯一`ID`。可通过[DescribeCrossBorderCompliance](https://cloud.tencent.com/document/product/215/47838)接口查询ComplianceId信息", "example": "10006" }, { "name": "AuditBehavior", "type": "string", "required": true, "description": "通过：`APPROVED `，拒绝：`DENY`。", "example": "DENY" } ], "required": [ "ServiceProvider", "ComplianceId", "AuditBehavior" ] }, { "name": "CheckAssistantCidr", "description": "本接口（CheckAssistantCidr）用于检查辅助CIDR是否与存量路由、对等连接（对端VPC的CIDR）等资源存在冲突。如果存在重叠，则返回重叠的资源。 * 检测辅助CIDR是否与当前VPC的主CIDR和辅助CIDR存在重叠。 * 检测辅助CIDR是否与当前VPC的路由的目的端存在重叠。 * 检测辅助CIDR是否与当前VPC的对等连接，对端VPC下的主CIDR或辅助CIDR存在重叠。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "`VPC`实例`ID`。形如：`vpc-6v2ht8q5`", "example": "vpc-12345678" }, { "name": "NewCidrBlocks", "type": "array", "required": false, "description": "待添加的辅助CIDR。CIDR数组，格式如[\"10.0.0.0/16\", \"172.16.0.0/16\"]。入参NewCidrBlocks和OldCidrBlocks至少需要其一。", "example": "[\"172.16.0.0\\/24\\n\"]", "item_type": "string" }, { "name": "OldCidrBlocks", "type": "array", "required": false, "description": "待删除的辅助CIDR。CIDR数组，格式如[\"10.0.0.0/16\", \"172.16.0.0/16\"]。入参NewCidrBlocks和OldCidrBlocks至少需要其一。", "example": "[\"172.16.1.0\\/25\\n\"]", "item_type": "string" } ], "required": [ "VpcId" ] }, { "name": "CheckDefaultSubnet", "description": "本接口（CheckDefaultSubnet）用于预判是否可建默认子网。", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": false, "description": "子网所在的可用区ID，不同子网选择不同可用区可以做跨可用区灾备。", "example": "ap-guangzhou" } ], "required": [] }, { "name": "CheckGatewayFlowMonitor", "description": "本接口（CheckGatewayFlowMonitor）用于查询网关是否启用流量监控。", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关实例ID，目前我们支持的网关实例类型有， 专线网关实例ID，形如，`dcg-ltjahce6`； Nat网关实例ID，形如，`nat-ltjahce6`； VPN网关实例ID，形如，`vpn-ltjahce6`。", "example": "vpngw-4je9dgin" } ], "required": [ "GatewayId" ] }, { "name": "CheckNetDetectState", "description": "本接口（CheckNetDetectState）用于验证网络探测。", "status": "online", "parameters": [ { "name": "DetectDestinationIp", "type": "array", "required": true, "description": "探测目的IPv4地址数组，最多两个。", "example": "[\"10.0.0.2\\r\\n\",\"10.0.0.3\\r\\n\"]", "item_type": "string" }, { "name": "NetDetectId", "type": "string", "required": false, "description": "网络探测实例ID。形如：netd-12345678。该参数与（VpcId，SubnetId，NetDetectName），至少要有一个。当NetDetectId存在时，使用NetDetectId。", "example": "netd-12345678" }, { "name": "VpcId", "type": "string", "required": false, "description": "`VPC`实例`ID`。形如：`vpc-12345678`。该参数与（SubnetId，NetDetectName）配合使用，与NetDetectId至少要有一个。当NetDetectId存在时，使用NetDetectId。", "example": "vpc-7zayowkt" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网实例ID。形如：subnet-12345678。该参数与（VpcId，NetDetectName）配合使用，与NetDetectId至少要有一个。当NetDetectId存在时，使用NetDetectId。", "example": "subnet-siqkaiqm" }, { "name": "NetDetectName", "type": "string", "required": false, "description": "网络探测名称，最大长度不能超过60个字节。该参数与（VpcId，SubnetId）配合使用，与NetDetectId至少要有一个。当NetDetectId存在时，使用NetDetectId。", "example": "name" }, { "name": "NextHopType", "type": "string", "required": false, "description": "下一跳类型，目前我们支持的类型有： VPN：VPN网关； DIRECTCONNECT：专线网关； PEERCONNECTION：对等连接； NAT：NAT网关； NORMAL_CVM：普通云服务器； CCN：云联网网关； NONEXTHOP：无下一跳；", "example": "NORMAL_CVM" }, { "name": "NextHopDestination", "type": "string", "required": false, "description": "下一跳目的网关，取值与“下一跳类型”相关： 下一跳类型为VPN，取值VPN网关ID，形如：vpngw-12345678； 下一跳类型为DIRECTCONNECT，取值专线网关ID，形如：dcg-12345678； 下一跳类型为PEERCONNECTION，取值对等连接ID，形如：pcx-12345678； 下一跳类型为NAT，取值Nat网关，形如：nat-12345678； 下一跳类型为NORMAL_CVM，取值云服务器IPv4地址，形如：10.0.0.12； 下一跳类型为CCN，取值云联网ID，形\ufffd\ufffd...", "example": "10.0.0.4" } ], "required": [ "DetectDestinationIp" ] }, { "name": "CheckTrafficMirror", "description": "检查流量镜像的采集端接收端（公网IP类型）", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "流量镜像所属的vpc", "example": "vpc-bx0vq62" }, { "name": "TrafficMirrorId", "type": "string", "required": false, "description": "流量镜像的实例id", "example": "imgf-cvfp7xo8" }, { "name": "CollectorSources", "type": "array", "required": false, "description": "流量镜像的采集端IP列表", "example": "['10.0.0.1']", "item_type": "string" }, { "name": "SubnetId", "type": "string", "required": false, "description": "流量镜像的接收端的子网", "example": "subnet-dl3wd0vq" }, { "name": "CollectorTarget", "type": "array", "required": false, "description": "流量镜像采集端的", "example": "无", "item_type": "object", "children": [ { "name": "TargetIps", "type": "array", "required": false, "description": "流量镜像的接收IP", "example": "[\"10.0.0.0\"]", "item_type": "string" }, { "name": "AlgHash", "type": "string", "required": false, "description": "流量镜像接收IP组，均衡规则，支持ENI/FIVE_TUPLE_FLOW（vpc），FIVE_TUPLE_FLOW（公网IP）", "example": "FIVE_TUPLE_FLOW" }, { "name": "TargetEndPoints", "type": "array", "required": false, "description": "流量镜像的接收endpoint（公网IP）", "example": "10.0.0.0", "item_type": "string" }, { "name": "TargetType", "type": "string", "required": false, "description": "流量镜像的接收类型，分别为：IP/ENI/CLB", "example": "IP" } ] } ], "required": [ "VpcId" ] }, { "name": "ClearRouteTableSelectionPolicies", "description": "本接口（ClearRouteTableSelectionPolicies）用于清空指定云联网的路由表选择策略。", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "云联网ID。", "example": "ccn-1234edfr" } ], "required": [ "CcnId" ] }, { "name": "CloneSecurityGroup", "description": "本接口（CloneSecurityGroup）用于根据存量的安全组，克隆创建出同样规则配置的安全组。默认仅克隆安全组及其规则信息，可通过入参开启克隆安全组标签信息。", "status": "online", "parameters": [ { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组实例ID，例如sg-33ocnj9n，可通过DescribeSecurityGroups获取。", "example": "sg-4esrjvgl" }, { "name": "GroupName", "type": "string", "required": false, "description": "安全组名称，可任意命名，但不得超过60个字符。未提供参数时，克隆后的安全组名称和SecurityGroupId对应的安全组名称相同。", "example": "demo" }, { "name": "GroupDescription", "type": "string", "required": false, "description": "安全组备注，最多100个字符。未提供参数时，克隆后的安全组备注和SecurityGroupId对应的安全组备注相同。", "example": "demo" }, { "name": "ProjectId", "type": "string", "required": false, "description": "项目ID，默认0。可在qcloud控制台项目管理页面查询到。", "example": "0" }, { "name": "RemoteRegion", "type": "string", "required": false, "description": "源Region,跨地域克隆安全组时，需要传入源安全组所属地域信息，例如：克隆广州的安全组到上海，则这里需要传入广州安全的地域信息：ap-guangzhou。", "example": "ap-guangzhou" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。 若指定Tags入参且指定IsCloneTags为true，会合并源安全组的标签和新增的标签。", "example": "[{\"Key\": \"city\", \"Value\": \"shanghai\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] }, { "name": "IsCloneTags", "type": "boolean", "required": false, "description": "是否克隆标签。", "example": "true" } ], "required": [ "SecurityGroupId" ] }, { "name": "CreateAddressTemplate", "description": "本接口（CreateAddressTemplate）用于创建IP地址模板。", "status": "online", "parameters": [ { "name": "AddressTemplateName", "type": "string", "required": true, "description": "IP地址模板名称。", "example": "TestName" }, { "name": "Addresses", "type": "array", "required": false, "description": "地址信息，支持 IP、CIDR、IP 范围。Addresses与AddressesExtra必填其一。", "example": "[\"192.168.1.0\\/24\\r\\n\",\"192.168.2.0\\/24\\r\\n\"]", "item_type": "string" }, { "name": "AddressesExtra", "type": "array", "required": false, "description": "地址信息，支持携带备注，支持 IP、CIDR、IP 范围。Addresses与AddressesExtra必填其一。", "example": "无", "item_type": "object", "children": [ { "name": "Address", "type": "string", "required": true, "description": "ip地址。", "example": "2.2.2.2" }, { "name": "Description", "type": "string", "required": false, "description": "备注。", "example": "desc" }, { "name": "UpdatedTime", "type": "string", "required": false, "description": "更新时间。", "example": "2020-08-10 18:10:12" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] } ], "required": [ "AddressTemplateName" ] }, { "name": "CreateAddressTemplateGroup", "description": "本接口（CreateAddressTemplateGroup）用于创建IP地址模板集合。", "status": "online", "parameters": [ { "name": "AddressTemplateGroupName", "type": "string", "required": true, "description": "IP地址模板集合名称。", "example": "demo" }, { "name": "AddressTemplateIds", "type": "array", "required": true, "description": "IP地址模板实例ID，例如：ipm-mdunqeb6。", "example": "[\"ipm-88t6207k\",\"ipm-mdunqeb6\"]", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", "example": "[{\"Key\": \"env\", \"Value\": \"prod\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] } ], "required": [ "AddressTemplateGroupName", "AddressTemplateIds" ] }, { "name": "CreateAndAttachNetworkInterface", "description": "本接口（CreateAndAttachNetworkInterface）用于创建弹性网卡并绑定云服务器。 * 创建弹性网卡时可以指定内网IP，并且可以指定一个主IP，指定的内网IP必须在弹性网卡所在子网内，而且不能被占用。 * 创建弹性网卡时可以指定需要申请的内网IP数量，系统会随机生成内网IP地址。 * 一个弹性网卡支持绑定的IP地址是有限制的，更多资源限制信息详见弹性网卡使用限制。 * 创建弹性网卡\ufffd...", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC实例ID。可通过[DescribeVpcs](https://cloud.tencent.com/document/product/215/15778)接口获取。", "example": "vpc-m0c2kcun" }, { "name": "NetworkInterfaceName", "type": "string", "required": true, "description": "弹性网卡名称，最大长度不能超过60个字符。", "example": "eni-ed3452de" }, { "name": "SubnetId", "type": "string", "required": true, "description": "弹性网卡所在的子网实例ID，例如：subnet-0ap8nwca。可通过[DescribeSubnets](https://cloud.tencent.com/document/product/215/15784)接口获取。", "example": "subnet-76r802pg" }, { "name": "InstanceId", "type": "string", "required": true, "description": "云服务器实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/213/15728)接口获取。", "example": "ins-efe0238e" }, { "name": "PrivateIpAddresses", "type": "array", "required": false, "description": "指定的内网IP信息，单次最多指定10个。", "example": "[{\"PrivateIpAddress\": \"10.0.0.10\"}]", "item_type": "object", "children": [ { "name": "PrivateIpAddress", "type": "string", "required": false, "description": "内网IP地址。", "example": "192.168.0.10" }, { "name": "Primary", "type": "boolean", "required": false, "description": "是否是主IP。", "example": "false" }, { "name": "PublicIpAddress", "type": "string", "required": false, "description": "公网IP地址。", "example": "123.10.100.171" }, { "name": "AddressId", "type": "string", "required": false, "description": "EIP实例ID，例如：eip-11112222。", "example": "eip-29mdigub" }, { "name": "Description", "type": "string", "required": false, "description": "内网IP描述信息。", "example": "demo" }, { "name": "IsWanIpBlocked", "type": "boolean", "required": false, "description": "公网IP是否被封堵。", "example": "false" }, { "name": "State", "type": "string", "required": false, "description": "IP状态： PENDING：生产中 MIGRATING：迁移中 DELETING：删除中 AVAILABLE：可用的", "example": "AVAILABLE" }, { "name": "QosLevel", "type": "string", "required": false, "description": "IP服务质量等级，可选值：PT（云金）、AU（云银）、AG(云铜）、DEFAULT（默认）。", "example": "PT" } ] }, { "name": "SecondaryPrivateIpAddressCount", "type": "integer", "required": false, "description": "新申请的内网IP地址个数，内网IP地址个数总和不能超过配额数。", "example": "1" }, { "name": "QosLevel", "type": "string", "required": false, "description": "IP服务质量等级，和SecondaryPrivateIpAddressCount配合使用，可选值：PT（云金）、AU（云银）、AG(云铜）、DEFAULT（默认）。", "example": "PT" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "指定绑定的安全组，例如：['sg-1dd51d']。可通过[DescribeSecurityGroups](https://cloud.tencent.com/document/product/215/15808)接口获取。", "example": "[\"sg-lb68uglp\"]", "item_type": "string" }, { "name": "NetworkInterfaceDescription", "type": "string", "required": false, "description": "弹性网卡描述，可任意命名，但不得超过60个字符。", "example": "demo" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", "example": "[{\"Key\": \"env\", \"Value\": \"prod\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] }, { "name": "AttachType", "type": "integer", "required": false, "description": "绑定类型：0 标准型 1 扩展型。", "example": "1" }, { "name": "IsRdma", "type": "boolean", "required": false, "description": "是否创建RDMA弹性网卡，true:创建rdma弹性网卡，false:普通弹性网卡。不填默认为false。", "example": "true" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "d7df28fd-dcba-4dbb-82bc-bce3bf4d3562" } ], "required": [ "VpcId", "NetworkInterfaceName", "SubnetId", "InstanceId" ] }, { "name": "CreateAssistantCidr", "description": "本接口（CreateAssistantCidr）用于批量创建辅助CIDR。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "`VPC`实例`ID`。形如：`vpc-6v2ht8q5`", "example": "vpc-n0yejvje" }, { "name": "CidrBlocks", "type": "array", "required": true, "description": "CIDR数组，格式如[\"10.0.0.0/16\", \"172.16.0.0/16\"]", "example": "[\"10.0.0.0/16\"]", "item_type": "string" } ], "required": [ "VpcId", "CidrBlocks" ] }, { "name": "CreateBandwidthPackage", "description": "本接口 (CreateBandwidthPackage) 支持创建[设备带宽包](https://cloud.tencent.com/document/product/684/15245#bwptype)和[IP带宽包](https://cloud.tencent.com/document/product/684/15245#bwptype)。", "status": "online", "parameters": [ { "name": "NetworkType", "type": "string", "required": false, "description": "带宽包类型, 默认值: BGP, 可选值: BGP: 普通BGP共享带宽包 HIGH_QUALITY_BGP: 精品BGP共享带宽包 SINGLEISP_CMCC: 中国移动共享带宽包 SINGLEISP_CTCC: 中国电信共享带宽包 SINGLEISP_CUCC: 中国联通共享带宽包 注意：仅部分地域支持三网带宽包和精品BGP带宽包。", "example": "BGP" }, { "name": "ChargeType", "type": "string", "required": false, "description": "带宽包计费类型, 默认为: ENHANCED95_POSTPAID_BY_MONTH, 可选值: ENHANCED95_POSTPAID_BY_MONTH: 后付费-增强型95计费 PRIMARY_TRAFFIC_POSTPAID_BY_HOUR: 后付费-按主流量计费 BANDWIDTH_POSTPAID_BY_DAY: 常规BGP-后付费-按带宽计费 FIXED_PREPAID_BY_MONTH: 常规BGP-预付费 PEAK_BANDWIDTH_POSTPAID_BY_DAY: 静态单线-后付费-按日结算 TOP5_POSTPAID_BY_MONTH: 后付费-TOP5计费，如需使用，请提交工单申请", "example": "ENHANCED95_POSTPAID_BY_MONTH" }, { "name": "BandwidthPackageName", "type": "string", "required": false, "description": "带宽包名称。名称长度小于60，只包含数字、字母和下划线。", "example": "demo" }, { "name": "BandwidthPackageCount", "type": "integer", "required": false, "description": "带宽包数量(传统账户类型只能填1), 标准账户类型取值范围为1~20。默认为1。", "example": "1" }, { "name": "InternetMaxBandwidth", "type": "integer", "required": false, "description": "带宽包限速大小。单位：Mbps，-1表示不限速。带宽包计费类型对应的带宽上下限可参考：[BandwidthRange](https://cloud.tencent.com/document/api/215/15824#BandwidthRange)", "example": "300" }, { "name": "Tags", "type": "array", "required": false, "description": "需要关联的标签列表。", "example": "[{\"Key\": \"key\", \"Value\": \"value\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] }, { "name": "Protocol", "type": "string", "required": false, "description": "带宽包协议类型。当前支持'ipv4'和'ipv6'协议带宽包，默认值是'ipv4'。", "example": "IPV4" }, { "name": "TimeSpan", "type": "integer", "required": false, "description": "预付费包月带宽包的购买时长，单位: 月，取值范围: 1~60。预付费计费类型必传。", "example": "1" }, { "name": "Egress", "type": "string", "required": false, "description": "网络出口，默认值：center_egress1，其它可选值：center_egress2、center_egress3。", "example": "center_egress1" } ], "required": [] }, { "name": "CreateCcn", "description": "本接口（CreateCcn）用于创建云联网（CCN）。 * 创建云联网同时可以绑定标签, 应答里的标签列表代表添加成功的标签。 * 每个账号能创建的云联网实例个数是有限的，详请参考产品文档。如果需要扩充请联系在线客服。", "status": "online", "parameters": [ { "name": "CcnName", "type": "string", "required": true, "description": "CCN名称，最大长度不能超过60个字节。", "example": "test+name" }, { "name": "CcnDescription", "type": "string", "required": false, "description": "CCN描述信息，最大长度不能超过100个字节。", "example": "test+description" }, { "name": "QosLevel", "type": "string", "required": false, "description": "CCN服务质量，`PT`：白金，`AU`：金，`AG`：银，默认为`AU`。", "example": "PT" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "计费模式，`PREPAID`：表示预付费，即包年包月，`POSTPAID`：表示后付费，即按量计费。默认：`POSTPAID`。", "example": "PREPAID" }, { "name": "InstanceMeteringType", "type": "string", "required": false, "description": "计量模式,`BANDWIDTH`：表示带宽,即带宽计量模式，`TRAFFIC`：表示流量,即流量计量模式。", "example": "BANDWIDTH" }, { "name": "BandwidthLimitType", "type": "string", "required": false, "description": "限速类型，`OUTER_REGION_LIMIT`表示地域出口限速，`INTER_REGION_LIMIT`为地域间限速，默认为`OUTER_REGION_LIMIT`。预付费模式仅支持地域间限速，后付费模式支持地域间限速和地域出口限速。", "example": "OUTER_REGION_LIMIT" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] } ], "required": [ "CcnName" ] }, { "name": "CreateCcnPolicyBasedRoutingNextHop", "description": "创建云联网策略路由下一跳", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "云联网ID", "example": "ccn-2gx0nr9r" }, { "name": "NextHopRegion", "type": "string", "required": true, "description": "下一跳地域", "example": "ap-guangzhou" }, { "name": "InstanceId", "type": "string", "required": true, "description": "关联实例ID", "example": "vpc-6zgq4gsp" }, { "name": "Name", "type": "string", "required": true, "description": "名称", "example": "next-hop" }, { "name": "InstanceType", "type": "string", "required": true, "description": "关联实例类型[VPC,DIRECTCONNECT,VPNGW]", "example": "VPC" }, { "name": "State", "type": "string", "required": false, "description": "状态", "example": "ENABLE/DISABLE" }, { "name": "Description", "type": "string", "required": false, "description": "描述", "example": "next-hop" }, { "name": "NextHopResourceType", "type": "string", "required": false, "description": "下一跳资源类型[HAVIP, GWLB_ENDPOINT]", "example": "HAVIP" }, { "name": "NextHopResourceId", "type": "string", "required": false, "description": "下一跳资源ID", "example": "havip-lmojafue" } ], "required": [ "CcnId", "NextHopRegion", "InstanceId", "Name", "InstanceType" ] }, { "name": "CreateCcnPolicyBasedRoutingRules", "description": "创建云联网策略路由匹配规则", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "云联网ID", "example": "ccn-2gx0nr9r" }, { "name": "CcnPolicyBasedRoutingRuleSet", "type": "array", "required": false, "description": "云联网策略路由匹配规则", "example": "无", "item_type": "object", "children": [ { "name": "PolicyBasedRoutingNextHopId", "type": "string", "required": true, "description": "策略路由下一跳ID", "example": "pbrnh-8kas9zm7" }, { "name": "InstanceType", "type": "string", "required": true, "description": "实例类型[VPC,DIRECTCONNECT,VPNGW]", "example": "VPC" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "vpc-6zgq4gsp" }, { "name": "SourceCidrBlock", "type": "string", "required": true, "description": "源地址CIDR", "example": "10.0.0.0/16" }, { "name": "DestinationCidrBlock", "type": "string", "required": true, "description": "目的地址CIDR", "example": "192.168.0.0/24" }, { "name": "Priority", "type": "integer", "required": true, "description": "优先级", "example": "1" }, { "name": "Description", "type": "string", "required": false, "description": "描述", "example": "rule" }, { "name": "PolicyBasedRoutingRuleId", "type": "string", "required": false, "description": "策略路由匹配策略ID", "example": "pbrrule-145s8ebs" } ] } ], "required": [ "CcnId" ] }, { "name": "CreateCcnRouteTables", "description": "本接口（CreateCcnRouteTables）用于给指定的云联网实例新建路由表。", "status": "online", "parameters": [ { "name": "RouteTable", "type": "array", "required": true, "description": "需要创建的路由表列表。", "example": "{'CcnId': 'ccn-xxxxxxxx', 'Name': 'ccn', 'Description': 'ccn'}", "item_type": "object", "children": [ { "name": "CcnId", "type": "string", "required": true, "description": "云联网ID。", "example": "ccn-245ecr35" }, { "name": "Name", "type": "string", "required": true, "description": "云联网路由表名称。", "example": "local" }, { "name": "Description", "type": "string", "required": false, "description": "云联网路由表描述。", "example": "deerers" } ] } ], "required": [ "RouteTable" ] }, { "name": "CreateCdcLDCXList", "description": "创建 IDC 通道", "status": "online", "parameters": [], "required": [] }, { "name": "CreateCdcNetPlanes", "description": "创建虚拟连接，用于支持 CDC 多租户模式", "status": "online", "parameters": [], "required": [] }, { "name": "CreateCustomerGateway", "description": "本接口（CreateCustomerGateway）用于创建对端网关。", "status": "online", "parameters": [ { "name": "CustomerGatewayName", "type": "string", "required": true, "description": "对端网关名称，可任意命名，但不得超过60个字符。", "example": "test-cgw" }, { "name": "IpAddress", "type": "string", "required": true, "description": "对端网关公网IP。", "example": "58.211.1.12" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]", "example": "[{\"Key\": \"name\", \"Value\": \"123\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] }, { "name": "BgpAsn", "type": "integer", "required": false, "description": "BGP ASN。ASN取值范围为1- 4294967295，其中139341、45090和58835不可用。", "example": "51613" } ], "required": [ "CustomerGatewayName", "IpAddress" ] }, { "name": "CreateDefaultSecurityGroup", "description": "本接口（CreateDefaultSecurityGroup）用于创建（如果项目下未存在默认安全组，则创建；已存在则获取。）默认安全组（SecurityGroup）。 * 每个账户下每个地域的每个项目的安全组数量限制。 * 默认安全组会放通所有IPv4规则，在创建后通常您需要再调用CreateSecurityGroupPolicies将安全组的规则设置为需要的规则。 * 创建安全组同时可以绑定标签, 应答里的标签列表代表添加成功的标签。", "status": "online", "parameters": [ { "name": "ProjectId", "type": "string", "required": false, "description": "项目ID，默认0。可在qcloud控制台项目管理页面查询到。", "example": "0" } ], "required": [] }, { "name": "CreateDefaultVpc", "description": "本接口（CreateDefaultVpc）用于创建默认私有网络(VPC）。 默认VPC适用于快速入门和启动公共实例，您可以像使用任何其他VPC一样使用默认VPC。如果您想创建标准VPC，即指定VPC名称、VPC网段、子网网段、子网可用区，请使用常规创建VPC接口（CreateVpc） 正常情况，本接口并不一定生产默认VPC，而是根据用户账号的网络属性（DescribeAccountAttributes）来决定的 * 支持基础网络、VPC，返回Vpc...", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": false, "description": "子网所在的可用区，该参数可通过[DescribeZones](https://cloud.tencent.com/document/product/213/15707)接口获取，例如ap-guangzhou-1，不指定时将随机选择可用区。", "example": "ap-guangzhou-1" }, { "name": "Force", "type": "boolean", "required": false, "description": "是否强制返回默认VPC。", "example": "true" } ], "required": [] }, { "name": "CreateDhcpIp", "description": "本接口（CreateDhcpIp）用于创建DhcpIp。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "私有网络`ID`。", "example": "vpc-5k6fot41" }, { "name": "SubnetId", "type": "string", "required": true, "description": "子网`ID`。", "example": "subnet-kgpu7qt2" }, { "name": "DhcpIpName", "type": "string", "required": true, "description": "`DhcpIp`名称。", "example": "demo" }, { "name": "SecondaryPrivateIpAddressCount", "type": "integer", "required": false, "description": "新申请的内网IP地址个数。总数不能超过64个，为了兼容性，当前参数必填。", "example": "1" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", "example": "[{\"Key\": \"env\", \"Value\": \"prod\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] } ], "required": [ "VpcId", "SubnetId", "DhcpIpName" ] }, { "name": "CreateDirectConnectGateway", "description": "本接口（CreateDirectConnectGateway）用于创建专线网关。", "status": "online", "parameters": [ { "name": "DirectConnectGatewayName", "type": "string", "required": true, "description": "专线网关名称", "example": "我的网关" }, { "name": "NetworkType", "type": "string", "required": true, "description": "关联网络类型，可选值： VPC - 私有网络 CCN - 云联网", "example": "VPC" }, { "name": "NetworkInstanceId", "type": "string", "required": false, "description": "NetworkType 为 VPC 时，这里传值为私有网络实例ID NetworkType 为 CCN 时，这里传值为云联网实例ID", "example": "vpc-m7sr81gh" }, { "name": "GatewayType", "type": "string", "required": false, "description": "网关类型，可选值： NORMAL - （默认）标准型，注：云联网只支持标准型 NAT - NAT型NAT类型支持网络地址转换配置，类型确定后不能修改；一个私有网络可以创建一个NAT类型的专线网关和一个非NAT类型的专线网关", "example": "NAT" }, { "name": "ModeType", "type": "string", "required": false, "description": "云联网路由发布模式，可选值：`standard`（标准模式）、`exquisite`（精细模式）。只有云联网类型专线网关才支持`ModeType`。", "example": "standard" }, { "name": "GatewayAsn", "type": "integer", "required": false, "description": "专线网关自定义ASN，范围：45090，64512-65534 和4200000000-4294967294", "example": "45090" }, { "name": "Zone", "type": "string", "required": false, "description": "专线网关可用区", "example": "ap-guangzhou-1" }, { "name": "HaZoneGroupId", "type": "string", "required": false, "description": "专线网关高可用区容灾组ID", "example": "ha_gourp_1" }, { "name": "Tags", "type": "array", "required": false, "description": "标签", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] } ], "required": [ "DirectConnectGatewayName", "NetworkType" ] }, { "name": "CreateDirectConnectGatewayCcnRoutes", "description": "本接口（CreateDirectConnectGatewayCcnRoutes）用于创建专线网关的云联网路由（IDC网段）", "status": "online", "parameters": [ { "name": "DirectConnectGatewayId", "type": "string", "required": true, "description": "专线网关ID，形如：dcg-prpqlmg1", "example": "dcg-prpqlmg1" }, { "name": "Routes", "type": "array", "required": true, "description": "需要连通的IDC网段列表", "example": "无", "item_type": "object", "children": [ { "name": "RouteId", "type": "string", "required": false, "description": "路由ID。", "example": "dcr-xxxxxxx" }, { "name": "DestinationCidrBlock", "type": "string", "required": false, "description": "IDC网段。", "example": "192.168.1.0/24" }, { "name": "ASPath", "type": "array", "required": false, "description": "`BGP`的`AS-Path`属性。", "example": "['2342', '342']", "item_type": "string" }, { "name": "Description", "type": "string", "required": false, "description": "备注", "example": "备注" }, { "name": "UpdateTime", "type": "string", "required": false, "description": "最后更新时间", "example": "2021-01-01 00:00:00" } ] } ], "required": [ "DirectConnectGatewayId", "Routes" ] }, { "name": "CreateFlowLog", "description": "本接口（CreateFlowLog）用于创建网络流日志。", "status": "online", "parameters": [ { "name": "FlowLogName", "type": "string", "required": true, "description": "流日志实例名称。长度为不超过60个字符。", "example": "check-flowlog" }, { "name": "ResourceType", "type": "string", "required": true, "description": "流日志所属资源类型，NETWORKINTERFACE（网卡），CCN（云联网），NAT（网络地址转化），DCG（专线网关）。当选择CCN，DCG时，请通过工单加入白名单。", "example": "NETWORKINTERFACE" }, { "name": "ResourceId", "type": "string", "required": true, "description": "资源唯一ID。", "example": "eni-b4ax8qbz" }, { "name": "TrafficType", "type": "string", "required": true, "description": "流日志采集类型，ACCEPT（允许），REJECT（拒绝），ALL（全部）。", "example": "ACCEPT" }, { "name": "VpcId", "type": "string", "required": false, "description": "私用网络唯一ID。当ResourceType为CCN时不填，其他类型必填。", "example": "vpc-5k6fot41" }, { "name": "FlowLogDescription", "type": "string", "required": false, "description": "流日志实例描述。长度不超过512个字符。", "example": "check-flowlog" }, { "name": "CloudLogId", "type": "string", "required": false, "description": "流日志存储ID（cls的日志主题ID， 可通过[DescribeTopics](https://cloud.tencent.com/document/product/614/56454)接口获取）。当StorageType为cls时，CloudLogId为必选。", "example": "99991111-2222-4444-9999-222266663333" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] }, { "name": "StorageType", "type": "string", "required": false, "description": "消费端类型：cls、ckafka。默认值cls。当选择ckafka时，请通过工单加入白名单。", "example": "cls" }, { "name": "FlowLogStorage", "type": "object", "required": false, "description": "流日志消费端信息，当消费端类型为ckafka时，必填。", "example": "无", "children": [ { "name": "StorageId", "type": "string", "required": true, "description": "存储实例Id，当流日志存储类型为ckafka时，必填。", "example": "ckafka-aso1kaoq" }, { "name": "StorageTopic", "type": "string", "required": false, "description": "主题Id，当流日志存储类型为ckafka时，必填。", "example": "topic-asow02oa" } ] }, { "name": "CloudLogRegion", "type": "string", "required": false, "description": "流日志存储ID对应的地域，不传递默认为本地域。", "example": "ap-guangzhou" }, { "name": "Period", "type": "integer", "required": false, "description": "流日志采集周期，只支持CCN类型流日志。取值范围（单位s）：60， 300， 600。", "example": "300" } ], "required": [ "FlowLogName", "ResourceType", "ResourceId", "TrafficType" ] }, { "name": "CreateGlobalRoutes", "description": "本接口（CreateGlobalRoutes）用于创建全局路由。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC唯一Id。", "example": "vpc-mcqaoy0f" }, { "name": "GlobalRoutes", "type": "array", "required": true, "description": "全局路由对象。创建时必填参数： 'GatewayType'，'GatewayId'，'DestinationCidrBlock'。", "example": "[ { \"DestinationCidrBlock\": \"192.168.0.0/16\", \"GatewayType\": \"NORMAL_CVM\", \"GatewayId\": \"10.0.16.4\", \"Description\": \"ivan_gr\" } ]", "item_type": "object", "children": [ { "name": "VpcId", "type": "string", "required": false, "description": "作为出参展示，表示VPC唯一Id，。", "example": "vpc-mcqaoy0f" }, { "name": "GlobalRouteId", "type": "string", "required": false, "description": "全局路由唯一Id。", "example": "gr-bmenrwu2" }, { "name": "DestinationCidrBlock", "type": "string", "required": false, "description": "Ipv4目标网段。", "example": "192.168.0.0/20" }, { "name": "GatewayType", "type": "string", "required": false, "description": "下一跳类型，支持 NORMAL_CVM。", "example": "NORMAL_CVM" }, { "name": "GatewayId", "type": "string", "required": false, "description": "下一跳对象，如果GatewayType类型是NORMAL_CVM填写子机IP。", "example": "192.168.0.3" }, { "name": "Description", "type": "string", "required": false, "description": "备注。", "example": "gr_item" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "创建时间。", "example": "2010-11-21" }, { "name": "SubnetRouteAlgorithm", "type": "string", "required": false, "description": "支持的 ECMP算法有： - ECMP_QUINTUPLE_HASH：五元组hash - ECMP_SOURCE_DESTINATION_IP_HASH：源和目的IP hash - ECMP_DESTINATION_IP_HASH：目的IP hash - ECMP_SOURCE_IP_HASH：源IP hash。", "example": "ECMP_QUINTUPLE_HASH" } ] } ], "required": [ "VpcId", "GlobalRoutes" ] }, { "name": "CreateHaVip", "description": "本接口（CreateHaVip）用于创建高可用虚拟IP（HAVIP）。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "`HAVIP`所在私有网络`ID`。", "example": "vpc-6v2ht8q5" }, { "name": "HaVipName", "type": "string", "required": true, "description": "`HAVIP`名称。", "example": "HAVIP1" }, { "name": "SubnetId", "type": "string", "required": false, "description": "`HAVIP`所在子网`ID`。", "example": "subnet-qq51iwr4" }, { "name": "Vip", "type": "string", "required": false, "description": "指定虚拟IP地址，必须在`VPC`网段内且未被占用。不指定则自动分配。", "example": "10.4.6.15" }, { "name": "NetworkInterfaceId", "type": "string", "required": false, "description": "`HAVIP`所在弹性网卡`ID`。", "example": "eni-ph0075l1" }, { "name": "CheckAssociate", "type": "boolean", "required": false, "description": "是否开启`HAVIP`漂移时子机或网卡范围的校验。默认不开启。", "example": "True" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", "example": "[\"Key\":\"HAVIP1\", \"Value\":\"HAVIP1\"]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] }, { "name": "HaVipAssociationSet", "type": "array", "required": false, "description": "HaVip绑定的子机或网卡。最多支持10个实例。", "example": "[{\"InstanceType\": \"CVM\", \"InstanceId\": \"ins-mdunqeb6\"}]", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "HaVip绑定的子机或网卡唯一ID。", "example": "ins-3qx9elib" }, { "name": "HaVipId", "type": "string", "required": false, "description": "HaVip实例唯一ID。", "example": "havip-7tqt5jn6" }, { "name": "InstanceType", "type": "string", "required": false, "description": "HaVip绑定的类型。取值:CVM, ENI。", "example": "CVM" } ] }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "d7df28fd-dcba-4dbb-82bc-bce3bf4d3562" } ], "required": [ "VpcId", "HaVipName" ] }, { "name": "CreateHighPriorityRouteTable", "description": "高优路由表创建", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "待操作的VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。", "example": "vpc-2at5y1pn" }, { "name": "Name", "type": "string", "required": true, "description": "高优路由表名称，最大长度不能超过60个字节。", "example": "TEST_HP_RTB" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] } ], "required": [ "VpcId", "Name" ] }, { "name": "CreateHighPriorityRoutes", "description": "创建高优路由表条目。", "status": "online", "parameters": [ { "name": "HighPriorityRouteTableId", "type": "string", "required": true, "description": "高优路由表唯一 ID。", "example": "hprtb-18mot1fm" }, { "name": "HighPriorityRoutes", "type": "array", "required": true, "description": "高优路由表条目信息。", "example": "无", "item_type": "object", "children": [ { "name": "HighPriorityRouteTableId", "type": "string", "required": false, "description": "高优路由表唯一 ID", "example": "hprtb-18mot1fm" }, { "name": "HighPriorityRouteId", "type": "string", "required": false, "description": "高优路由表条目唯一 ID", "example": "hprti-p1ymd0ak" }, { "name": "DestinationCidrBlock", "type": "string", "required": false, "description": "目标网段", "example": "172.20.0.0/16" }, { "name": "GatewayType", "type": "string", "required": false, "description": "网关类型", "example": "HAVIP" }, { "name": "GatewayId", "type": "string", "required": false, "description": "网关唯一ID", "example": "havip-mt4yhdps" }, { "name": "Description", "type": "string", "required": false, "description": "高优路由条目描述", "example": "test_high_priority_item" }, { "name": "SubnetRouteAlgorithm", "type": "string", "required": false, "description": "ECMP算法，支持的算法有：ECMP_QUINTUPLE_HASH：五元组hash，ECMP_SOURCE_DESTINATION_IP_HASH：源和目的IP hash，ECMP_DESTINATION_IP_HASH：目的IP hash，ECMP_SOURCE_IP_HASH：源IP hash。", "example": "ECMP_QUINTUPLE_HASH" }, { "name": "IsCdc", "type": "boolean", "required": false, "description": "出参展示，是否为CDC属性高优路由", "example": "true" }, { "name": "CdcId", "type": "string", "required": false, "description": "出参展示，CDC 唯一ID", "example": "cdc-hj3he929" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "创建时间。", "example": "2021-03-02 14:41:15" } ] } ], "required": [ "HighPriorityRouteTableId", "HighPriorityRoutes" ] }, { "name": "CreateIp6Translators", "description": "1. 该接口用于创建IPV6转换IPV4实例，支持批量 2. 同一个账户在一个地域最多允许创建10个转换实例", "status": "online", "parameters": [ { "name": "Ip6TranslatorName", "type": "string", "required": false, "description": "转换实例名称", "example": "\"www_lakalakk\"" }, { "name": "Ip6TranslatorCount", "type": "integer", "required": false, "description": "创建转换实例数量，默认是1个", "example": "1" }, { "name": "Ip6InternetServiceProvider", "type": "string", "required": false, "description": "转换实例运营商属性，可取\"CMCC\",\"CTCC\",\"CUCC\",\"BGP\"", "example": "\"BGP\"" } ], "required": [] }, { "name": "CreateLocalGateway", "description": "本接口（CreateLocalGateway）用于创建用于CDC的本地网关。", "status": "online", "parameters": [ { "name": "LocalGatewayName", "type": "string", "required": true, "description": "本地网关名称。", "example": "demo" }, { "name": "VpcId", "type": "string", "required": true, "description": "VPC实例ID。", "example": "vpc-m0c2kcun" }, { "name": "CdcId", "type": "string", "required": true, "description": "CDC实例ID。", "example": "cluster-gbo27yc4" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", "example": "[{\"Key\": \"env\", \"Value\": \"prod\"}][]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] } ], "required": [ "LocalGatewayName", "VpcId", "CdcId" ] }, { "name": "CreateNatGateway", "description": "本接口(CreateNatGateway)用于创建NAT网关。 在对新建的NAT网关做其他操作前，需先确认此网关已被创建完成（DescribeNatGateway接口返回的实例State字段为AVAILABLE）。", "status": "online", "parameters": [ { "name": "NatGatewayName", "type": "string", "required": true, "description": "NAT网关名称，限制60字符", "example": "test_name" }, { "name": "VpcId", "type": "string", "required": true, "description": "VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。", "example": "vpc-acbedgfh" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "NAT网关最大外网出带宽(单位：Mbps)，支持的参数值：20, 50, 100, 200, 500, 1000, 2000, 5000，默认: 100Mbps。 当以下NatProductVersion参数值为2即标准型时，此参数无需填写，默认为5000Mbps。", "example": "10" }, { "name": "MaxConcurrentConnection", "type": "integer", "required": false, "description": "NAT网关并发连接数上限，支持参数值：1000000、3000000、10000000，默认值为1000000。 当NatProductVersion参数值为2即标准型时，此参数无需填写，默认为2000000。", "example": "1000000" }, { "name": "AddressCount", "type": "integer", "required": false, "description": "新建弹性公网IP个数，系统会按您的要求创建对应数量的弹性公网IP，其中AddressCount和PublicAddresses两个参数至少填写一个。", "example": "1" }, { "name": "PublicIpAddresses", "type": "array", "required": false, "description": "绑定NAT网关的已有弹性公网IP数组，其中AddressCount和PublicAddresses两个参数至少填写一个。 示例值：[\"139.199.232.119\"]", "example": "[\"139.199.232.119\"]", "item_type": "string" }, { "name": "Zone", "type": "string", "required": false, "description": "可用区，形如：`ap-guangzhou-1`。", "example": "ap-guangzhou-1" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] }, { "name": "StockPublicIpAddressesBandwidthOut", "type": "integer", "required": false, "description": "绑定NAT网关的弹性公网IP带宽值（单位：Mbps）。不填写此参数时：则该参数默认为弹性公网IP的带宽值，部分用户默认为该用户类型的弹性公网IP的带宽上限。", "example": "77" }, { "name": "PublicIpAddressesBandwidthOut", "type": "integer", "required": false, "description": "需要申请公网IP带宽大小（单位Mbps），默认为当前用户类型所能使用的最大值。", "example": "77" }, { "name": "PublicIpFromSameZone", "type": "boolean", "required": false, "description": "公网IP是否强制与NAT网关来自同可用区，true表示需要与NAT网关同可用区；false表示可与NAT网关不是同一个可用区。此参数只有当参数Zone存在时才能生效。", "example": "false" }, { "name": "NatProductVersion", "type": "integer", "required": false, "description": "NAT网关类型，1表示传统型NAT网关，2表示标准型NAT网关，默认值是1。", "example": "1" }, { "name": "DeletionProtectionEnabled", "type": "boolean", "required": false, "description": "NAT实例是否开启删除保护", "example": "false" }, { "name": "ExclusiveType", "type": "string", "required": false, "description": "独享实例规格。取值范围：ExclusiveSmall/ExclusiveMedium1/ExclusiveLarge1", "example": "ExclusiveLarge1" } ], "required": [ "NatGatewayName", "VpcId" ] }, { "name": "CreateNatGatewayDestinationIpPortTranslationNatRule", "description": "本接口(CreateNatGatewayDestinationIpPortTranslationNatRule)用于创建NAT网关端口转发规则。", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "NAT网关的ID，形如：`nat-df45454`。", "example": "nat-3isn9hr0" }, { "name": "DestinationIpPortTranslationNatRules", "type": "array", "required": true, "description": "NAT网关的端口转换规则。", "example": "无", "item_type": "object", "children": [ { "name": "IpProtocol", "type": "string", "required": true, "description": "网络协议，可选值：`TCP`、`UDP`。", "example": "TCP" }, { "name": "PublicIpAddress", "type": "string", "required": true, "description": "弹性IP。", "example": "114.182.81.73" }, { "name": "PublicPort", "type": "integer", "required": true, "description": "公网端口。", "example": "80" }, { "name": "PrivateIpAddress", "type": "string", "required": true, "description": "内网地址。", "example": "192.168.4.43" }, { "name": "PrivatePort", "type": "integer", "required": true, "description": "内网端口。", "example": "80" }, { "name": "Description", "type": "string", "required": false, "description": "NAT网关转发规则描述。", "example": "webservice" } ] } ], "required": [ "NatGatewayId", "DestinationIpPortTranslationNatRules" ] }, { "name": "CreateNatGatewaySourceIpTranslationNatRule", "description": "本接口(CreateNatGatewaySourceIpTranslationNatRule)用于创建NAT网关SNAT规则", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "NAT网关的ID，形如：\"nat-df45454\"", "example": "nat-3isn9hr0" }, { "name": "SourceIpTranslationNatRules", "type": "array", "required": true, "description": "NAT网关的SNAT转换规则", "example": "无", "item_type": "object", "children": [ { "name": "ResourceId", "type": "string", "required": true, "description": "资源ID，如果ResourceType为USERDEFINED，可以为空字符串", "example": "subnet-7aed90al" }, { "name": "ResourceType", "type": "string", "required": true, "description": "资源类型，目前包含SUBNET、NETWORKINTERFACE、USERDEFINED，分别表示子网、网卡、自定义网段", "example": "SUBNET" }, { "name": "PrivateIpAddress", "type": "string", "required": true, "description": "源IP/网段", "example": "172.168.100.0/24" }, { "name": "PublicIpAddresses", "type": "array", "required": true, "description": "弹性IP地址池", "example": "['180.12.59.43']", "item_type": "string" }, { "name": "Description", "type": "string", "required": true, "description": "规则描述", "example": "production subnet" }, { "name": "NatGatewaySnatId", "type": "string", "required": false, "description": "Snat规则ID", "example": "snat-3nptcfvp" }, { "name": "NatGatewayId", "type": "string", "required": false, "description": "NAT网关的ID。", "example": "nat-3nptcfvp" }, { "name": "VpcId", "type": "string", "required": false, "description": "私有网络VPC的ID。", "example": "vpc-oty76xyl" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "NAT网关SNAT规则创建时间。", "example": "2021-03-14 13:59:00" } ] } ], "required": [ "NatGatewayId", "SourceIpTranslationNatRules" ] }, { "name": "CreateNetDetect", "description": "本接口（CreateNetDetect）用于创建网络探测。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "`VPC`实例`ID`。形如：`vpc-12345678`。", "example": "vpc-5k6fot41" }, { "name": "SubnetId", "type": "string", "required": true, "description": "子网实例ID。形如：subnet-12345678。", "example": "subnet-kgpu7qt2" }, { "name": "NetDetectName", "type": "string", "required": true, "description": "网络探测名称，最大长度不能超过60个字节。", "example": "demo" }, { "name": "DetectDestinationIp", "type": "array", "required": true, "description": "探测目的IPv4地址数组。最多两个。", "example": "[\"10.0.0.2\",\"10.0.0.3\"]", "item_type": "string" }, { "name": "NextHopType", "type": "string", "required": false, "description": "下一跳类型，目前我们支持的类型有： VPN：VPN网关； DIRECTCONNECT：专线网关； PEERCONNECTION：对等连接； NAT：NAT网关； NORMAL_CVM：普通云服务器； CCN：云联网网关； NONEXTHOP：无下一跳；", "example": "NORMAL_CVM" }, { "name": "NextHopDestination", "type": "string", "required": false, "description": "下一跳目的网关，取值与“下一跳类型”相关： 下一跳类型为VPN，取值VPN网关ID，形如：vpngw-12345678； 下一跳类型为DIRECTCONNECT，取值专线网关ID，形如：dcg-12345678； 下一跳类型为PEERCONNECTION，取值对等连接ID，形如：pcx-12345678； 下一跳类型为NAT，取值Nat网关，形如：nat-12345678； 下一跳类型为NORMAL_CVM，取值云服务器IPv4地址，形如：10.0.0.12； 下一跳类型为CCN，取值云联网ID，形\ufffd\ufffd...", "example": "10.0.0.4" }, { "name": "NetDetectDescription", "type": "string", "required": false, "description": "网络探测描述。", "example": "demo" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", "example": "[{\"Key\": \"env\", \"Value\": \"prod\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] } ], "required": [ "VpcId", "SubnetId", "NetDetectName", "DetectDestinationIp" ] }, { "name": "CreateNetworkAcl", "description": "本接口（CreateNetworkAcl）用于创建新的网络ACL。 * 新建的网络ACL的入站和出站规则默认都是全部拒绝，在创建后通常您需要再调用ModifyNetworkAclEntries将网络ACL的规则设置为需要的规则。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。", "example": "vpc-dh9vyl2f" }, { "name": "NetworkAclName", "type": "string", "required": true, "description": "网络ACL名称，最大长度不能超过60个字节。", "example": "demo" }, { "name": "NetworkAclType", "type": "string", "required": false, "description": "网络ACL类型，三元组(TRIPLE)或五元组(QUINTUPLE)。默认值三元组(TRIPLE)。", "example": "TRIPLE,QUINTUPLE" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", "example": "[{\"Key\": \"env\", \"Value\": \"prod\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] } ], "required": [ "VpcId", "NetworkAclName" ] }, { "name": "CreateNetworkAclEntries", "description": "本接口（CreateNetworkAclEntries）用于增量添加网络ACL三元组的入站规则和出站规则。", "status": "online", "parameters": [ { "name": "NetworkAclId", "type": "string", "required": true, "description": "网络ACL实例ID。例如：acl-12345678。", "example": "acl-k23blx7p" }, { "name": "NetworkAclEntrySet", "type": "object", "required": true, "description": "网络三元组ACL规则集。", "example": "{\"Ingress\": [{\"Protocol\": \"TCP\", \"Port\": \"80\", \"CidrBlock\": \"192.168.0.0/24\", \"Action\": \"Accept\", \"Description\": \"demo\"}]", "children": [ { "name": "Ingress", "type": "array", "required": false, "description": "入站规则。", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP, ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。使用-指定端口范围，如：10-20。", "example": "8080" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)。增量创建ACL规则时，CidrBlock和Ipv6CidrBlock至少提供一个。", "example": "10.0.0.0/24" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。", "example": "3402:4e00:20:1200::/56" }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "Description", "type": "string", "required": false, "description": "规则描述，最大长度100。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间。", "example": "2018-04-25 10:26:26" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级，从1开始。", "example": "1" }, { "name": "NetworkAclIpv4EntryId", "type": "string", "required": false, "description": "IPv4网络ACL条目唯一ID。当修改ACL条目时，NetworkAclIpv4EntryId和NetworkAclIpv6EntryID至少提供一个。", "example": "acli43-0pngbwph" }, { "name": "NetworkAclIpv6EntryId", "type": "string", "required": false, "description": "IPv6网络ACL条目唯一ID。当修改ACL条目时，NetworkAclIpv4EntryId和NetworkAclIpv6EntryId至少提供一个。", "example": "acli46-0pngbwph" } ] }, { "name": "Egress", "type": "array", "required": false, "description": "出站规则。", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP, ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。使用-指定端口范围，如：10-20。", "example": "8080" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)。增量创建ACL规则时，CidrBlock和Ipv6CidrBlock至少提供一个。", "example": "10.0.0.0/24" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。", "example": "3402:4e00:20:1200::/56" }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "Description", "type": "string", "required": false, "description": "规则描述，最大长度100。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间。", "example": "2018-04-25 10:26:26" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级，从1开始。", "example": "1" }, { "name": "NetworkAclIpv4EntryId", "type": "string", "required": false, "description": "IPv4网络ACL条目唯一ID。当修改ACL条目时，NetworkAclIpv4EntryId和NetworkAclIpv6EntryID至少提供一个。", "example": "acli43-0pngbwph" }, { "name": "NetworkAclIpv6EntryId", "type": "string", "required": false, "description": "IPv6网络ACL条目唯一ID。当修改ACL条目时，NetworkAclIpv4EntryId和NetworkAclIpv6EntryId至少提供一个。", "example": "acli46-0pngbwph" } ] } ] } ], "required": [ "NetworkAclId", "NetworkAclEntrySet" ] }, { "name": "CreateNetworkAclQuintupleEntries", "description": "本接口（CreateNetworkAclQuintupleEntries）用于增量网络ACL五元组的入站规则和出站规则。", "status": "online", "parameters": [ { "name": "NetworkAclId", "type": "string", "required": true, "description": "网络ACL实例ID。例如：acl-12345678。", "example": "acl-k23blx7p" }, { "name": "NetworkAclQuintupleSet", "type": "object", "required": true, "description": "网络五元组ACL规则集。", "example": "{\"Ingress\": [{\"Protocol\": \"TCP\", \"DestinationCidr\": \"8.8.8.8\", \"SourceCidr\": \"10.0.0.12\", \"Action\": \"ACCEPT\"}]}}", "children": [ { "name": "Ingress", "type": "array", "required": false, "description": "网络ACL五元组入站规则。", "example": "[{ 'SourcePort':'446', 'SourceCidr': '10.0.0.2/24', 'Protocol': ", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP, ALL。", "example": "UDP" }, { "name": "Description", "type": "string", "required": false, "description": "描述。", "example": "demo" }, { "name": "SourcePort", "type": "string", "required": false, "description": "源端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。", "example": "446" }, { "name": "SourceCidr", "type": "string", "required": false, "description": "源CIDR。", "example": "192.168.0.0/24" }, { "name": "DestinationPort", "type": "string", "required": false, "description": "目的端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。", "example": "446" }, { "name": "DestinationCidr", "type": "string", "required": false, "description": "目的CIDR。", "example": "192.168.0.0/24" }, { "name": "Action", "type": "string", "required": false, "description": "动作，ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "NetworkAclQuintupleEntryId", "type": "string", "required": false, "description": "网络ACL条目唯一ID。", "example": "acli45-ahnu4rv5" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级，从1开始。", "example": "1" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间，用于DescribeNetworkAclQuintupleEntries的出参。", "example": "2021-03-02 14:41:15" }, { "name": "NetworkAclDirection", "type": "string", "required": false, "description": "方向，INGRESS或EGRESS，用于DescribeNetworkAclQuintupleEntries的出参。", "example": "INGRESS" }, { "name": "SourceIPv6Cidr", "type": "string", "required": false, "description": "IPv6源CIDR。", "example": "12::1/128" }, { "name": "DestinationIPv6Cidr", "type": "string", "required": false, "description": "IPv6目的CIDR。", "example": "13::1/128" } ] }, { "name": "Egress", "type": "array", "required": false, "description": "网络ACL五元组出站规则", "example": "[{ 'SourcePort':'446', 'SourceCidr': '10.0.0.2/24', 'Protocol': ", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP, ALL。", "example": "UDP" }, { "name": "Description", "type": "string", "required": false, "description": "描述。", "example": "demo" }, { "name": "SourcePort", "type": "string", "required": false, "description": "源端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。", "example": "446" }, { "name": "SourceCidr", "type": "string", "required": false, "description": "源CIDR。", "example": "192.168.0.0/24" }, { "name": "DestinationPort", "type": "string", "required": false, "description": "目的端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。", "example": "446" }, { "name": "DestinationCidr", "type": "string", "required": false, "description": "目的CIDR。", "example": "192.168.0.0/24" }, { "name": "Action", "type": "string", "required": false, "description": "动作，ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "NetworkAclQuintupleEntryId", "type": "string", "required": false, "description": "网络ACL条目唯一ID。", "example": "acli45-ahnu4rv5" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级，从1开始。", "example": "1" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间，用于DescribeNetworkAclQuintupleEntries的出参。", "example": "2021-03-02 14:41:15" }, { "name": "NetworkAclDirection", "type": "string", "required": false, "description": "方向，INGRESS或EGRESS，用于DescribeNetworkAclQuintupleEntries的出参。", "example": "INGRESS" }, { "name": "SourceIPv6Cidr", "type": "string", "required": false, "description": "IPv6源CIDR。", "example": "12::1/128" }, { "name": "DestinationIPv6Cidr", "type": "string", "required": false, "description": "IPv6目的CIDR。", "example": "13::1/128" } ] } ] } ], "required": [ "NetworkAclId", "NetworkAclQuintupleSet" ] }, { "name": "CreateNetworkInterface", "description": "本接口（CreateNetworkInterface）用于创建弹性网卡。 * 创建弹性网卡时可以指定内网IP，并且可以指定一个主IP，指定的内网IP必须在弹性网卡所在子网内，而且不能被占用。 * 创建弹性网卡时可以指定需要申请的内网IP数量，系统会随机生成内网IP地址。 * 一个弹性网卡支持绑定的IP地址是有限制的，更多资源限制信息详见弹性网卡使用限制。 * 创建弹性网卡同时可以绑定已有安全\ufffd...", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC实例ID。可通过[DescribeVpcs](https://cloud.tencent.com/document/product/215/15778)接口获取。", "example": "vpc-0akbol5v" }, { "name": "NetworkInterfaceName", "type": "string", "required": true, "description": "弹性网卡名称，最大长度不能超过60个字节。", "example": "demo" }, { "name": "SubnetId", "type": "string", "required": true, "description": "弹性网卡所在的子网实例ID，例如：subnet-0ap8nwca。可通过[DescribeSubnets](https://cloud.tencent.com/document/product/215/15784)接口获取。", "example": "subnet-76r802pg" }, { "name": "NetworkInterfaceDescription", "type": "string", "required": false, "description": "弹性网卡描述，可任意命名，但不得超过60个字符。", "example": "demo" }, { "name": "SecondaryPrivateIpAddressCount", "type": "integer", "required": false, "description": "新申请的内网IP地址个数，内网IP地址个数总和不能超过配额数。 配额数查询：[DescribeVpcLimits](https://cloud.tencent.com/document/api/215/42942)。", "example": "1" }, { "name": "QosLevel", "type": "string", "required": false, "description": "IP服务质量等级，和SecondaryPrivateIpAddressCount配合使用，可选值：PT（云金）、AU（云银）、AG(云铜）、DEFAULT（默认）。", "example": "PT" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "指定绑定的安全组，例如：['sg-1dd51d']。可通过[DescribeSecurityGroups](https://cloud.tencent.com/document/product/215/15808)接口获取。", "example": "[\"sg-05bb4upy\"]", "item_type": "string" }, { "name": "PrivateIpAddresses", "type": "array", "required": false, "description": "指定的内网IP信息，单次最多指定10个。", "example": "[{\"PrivateIpAddress\": \"192.168.0.10\"}]", "item_type": "object", "children": [ { "name": "PrivateIpAddress", "type": "string", "required": false, "description": "内网IP地址。", "example": "192.168.0.10" }, { "name": "Primary", "type": "boolean", "required": false, "description": "是否是主IP。", "example": "false" }, { "name": "PublicIpAddress", "type": "string", "required": false, "description": "公网IP地址。", "example": "123.10.100.171" }, { "name": "AddressId", "type": "string", "required": false, "description": "EIP实例ID，例如：eip-11112222。", "example": "eip-29mdigub" }, { "name": "Description", "type": "string", "required": false, "description": "内网IP描述信息。", "example": "demo" }, { "name": "IsWanIpBlocked", "type": "boolean", "required": false, "description": "公网IP是否被封堵。", "example": "false" }, { "name": "State", "type": "string", "required": false, "description": "IP状态： PENDING：生产中 MIGRATING：迁移中 DELETING：删除中 AVAILABLE：可用的", "example": "AVAILABLE" }, { "name": "QosLevel", "type": "string", "required": false, "description": "IP服务质量等级，可选值：PT（云金）、AU（云银）、AG(云铜）、DEFAULT（默认）。", "example": "PT" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]", "example": "[{\"Key\": \"env\", \"Value\": \"prod\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] }, { "name": "TrunkingFlag", "type": "string", "required": false, "description": "网卡trunking模式设置，Enable-开启，Disable--关闭，默认关闭。", "example": "Enable" }, { "name": "IsRdma", "type": "boolean", "required": false, "description": "是否创建RDMA弹性网卡，true:创建rdma弹性网卡，false:普通弹性网卡。不填默认为false", "example": "true" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "d7df28fd-dcba-4dbb-82bc-bce3bf4d3562" } ], "required": [ "VpcId", "NetworkInterfaceName", "SubnetId" ] }, { "name": "CreatePrivateNatGateway", "description": "本接口（CreatePrivateNatGateway）用于创建私网NAT网关。", "status": "online", "parameters": [ { "name": "NatGatewayName", "type": "string", "required": true, "description": "私网网关名称，限制60个字符", "example": "NATDemo" }, { "name": "VpcId", "type": "string", "required": false, "description": "私有网络实例ID。当创建VPC类型私网NAT网关或者专线网关类型私网NAT网关时，此参数必填。", "example": "vpc-m7sr81gh" }, { "name": "CrossDomain", "type": "boolean", "required": false, "description": "跨域参数。仅当取值为True时，才会支持跨域绑定VPC。", "example": "true" }, { "name": "Tags", "type": "array", "required": false, "description": "实例标签", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] }, { "name": "VpcType", "type": "boolean", "required": false, "description": "VPC类型私网NAT网关。仅当取值为True时，才会创建VPC类型私网NAT网关。", "example": "true" }, { "name": "CcnId", "type": "string", "required": false, "description": "云联网类型私网NAT网关需要绑定的云联网实例ID。", "example": "ccn-jq193paf" }, { "name": "DeletionProtectionEnabled", "type": "boolean", "required": false, "description": "私网NAT实例是否开启删除保护", "example": "false" } ], "required": [ "NatGatewayName" ] }, { "name": "CreatePrivateNatGatewayDestinationIpPortTranslationNatRule", "description": "本接口（CreatePrivateNatGatewayDestinationIpPortTranslationNatRule）用于创建私网NAT网关目的端口转换规则", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "私网网关唯一`ID`，形如：`intranat-xxxxxxxx`。", "example": "intranat-0g3blj80" }, { "name": "LocalDestinationIpPortTranslationNatRules", "type": "array", "required": true, "description": "目的端口转换规则列表。", "example": "无", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议，包含TCP和UDP", "example": "TCP" }, { "name": "OriginalPort", "type": "integer", "required": true, "description": "映射前端口", "example": "80" }, { "name": "OriginalIp", "type": "string", "required": true, "description": "映射前IP", "example": "192.168.4.43" }, { "name": "TranslationPort", "type": "integer", "required": true, "description": "映射后端口", "example": "80" }, { "name": "TranslationIp", "type": "string", "required": true, "description": "映射后IP", "example": "10.254.4.43" }, { "name": "Description", "type": "string", "required": false, "description": "描述", "example": "webservice" } ] } ], "required": [ "NatGatewayId", "LocalDestinationIpPortTranslationNatRules" ] }, { "name": "CreatePrivateNatGatewayTranslationAclRule", "description": "本接口（ CreatePrivateNatGatewayTranslationAclRule）用于创建私网NAT网关源端转换访问控制规则", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "私网网关唯一`ID`，形如：`intranat-xxxxxxxx`。", "example": "intranat-0g3blj80" }, { "name": "TranslationDirection", "type": "string", "required": true, "description": "转换规则目标，可选值LOCAL。", "example": "LOCAL" }, { "name": "TranslationType", "type": "string", "required": true, "description": "转换规则类型，可选值NETWORK_LAYER、TRANSPORT_LAYER。分别对应三层、四层。", "example": "TRANSPORT_LAYER" }, { "name": "TranslationIp", "type": "string", "required": true, "description": "映射后`IP`,当转换规则类型为四层时为`IP`池。", "example": "10.0.13.20" }, { "name": "TranslationAclRules", "type": "array", "required": true, "description": "访问控制列表。", "example": "无", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "ACL协议类型，可选值:\"ALL\",\"TCP\",\"UDP\"", "example": "\"ALL\"" }, { "name": "SourcePort", "type": "string", "required": true, "description": "源端口。", "example": "\"80\"" }, { "name": "DestinationPort", "type": "string", "required": true, "description": "目的端口。", "example": "\"8081\"" }, { "name": "DestinationCidr", "type": "string", "required": true, "description": "目的地址。", "example": "\"100.0.20.3\"" }, { "name": "SourceCidr", "type": "string", "required": false, "description": "源地址。支持`ip`或`cidr`格式\"xxx.xxx.xxx.000/xx\"", "example": "\"127.0.0.1\"" }, { "name": "AclRuleId", "type": "integer", "required": false, "description": "ACL规则`ID`。", "example": "1" }, { "name": "Action", "type": "integer", "required": false, "description": "是否匹配。", "example": "0" }, { "name": "Description", "type": "string", "required": false, "description": "ACL规则描述", "example": "\"ACL规则描述\"" } ] }, { "name": "OriginalIp", "type": "string", "required": false, "description": "映射前`IP`,当转换规则类型为三层时有效。", "example": "10.0.13.19" } ], "required": [ "NatGatewayId", "TranslationDirection", "TranslationType", "TranslationIp", "TranslationAclRules" ] }, { "name": "CreatePrivateNatGatewayTranslationNatRule", "description": "本接口（CreatePrivateNatGatewayTranslationNatRule）用于创建私网NAT网关源端转换规则。", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "私网网关唯一`ID`，形如：`intranat-xxxxxxxx`。", "example": "intranat-0g3blj80" }, { "name": "TranslationNatRules", "type": "array", "required": true, "description": "转换规则对象数组。", "example": "无", "item_type": "object", "children": [ { "name": "TranslationDirection", "type": "string", "required": true, "description": "转换规则目标，可选值\"LOCAL\",\"PEER\"。", "example": "\"LOCAL\"" }, { "name": "TranslationType", "type": "string", "required": true, "description": "转换规则类型，可选值\"NETWORK_LAYER\",\"TRANSPORT_LAYER\"。分别对应三层、四层。", "example": "\"NETWORK_LAYER\"" }, { "name": "TranslationIp", "type": "string", "required": true, "description": "映射后`IP`,当转换规则类型为四层时为`IP`池。", "example": "\"10.0.13.21\"" }, { "name": "Description", "type": "string", "required": false, "description": "转换规则描述。", "example": "my service" }, { "name": "OriginalIp", "type": "string", "required": false, "description": "映射前`IP`,当转换规则类型为三层时有效。", "example": "\"10.0.13.20\"" } ] }, { "name": "CrossDomain", "type": "boolean", "required": false, "description": "跨域参数，当VPC为跨域时填写为True。", "example": "true" } ], "required": [ "NatGatewayId", "TranslationNatRules" ] }, { "name": "CreateReserveIpAddresses", "description": "创建内网保留IP", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC唯一 ID。", "example": "vpc-mcqaoy0f" }, { "name": "IpAddresses", "type": "array", "required": false, "description": "指定IP申请的内网保留IP地址。", "example": "[\"10.0.1.9\"]", "item_type": "string" }, { "name": "IpAddressCount", "type": "integer", "required": false, "description": "不指定IP地址，指定个数自动分配保留内网IP。", "example": "1" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网唯一 ID。", "example": "subnet-j4oluywm" }, { "name": "Name", "type": "string", "required": false, "description": "内网保留 IP名称。", "example": "reserve_ip" }, { "name": "Description", "type": "string", "required": false, "description": "内网保留 IP描述。", "example": "desc_ivan" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", "example": "[ { \"Key\": \"ivan_tag\", \"Value\": \"hello\" } ]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "B1B615C4-9EBE-40FD-BC8D-8E2BE19F0309" } ], "required": [ "VpcId" ] }, { "name": "CreateRoutePolicy", "description": "创建VPC路由接收策略，包括名字，描述和策略条目。", "status": "online", "parameters": [ { "name": "RoutePolicyDescription", "type": "string", "required": true, "description": "路由策略描述。", "example": "TEST" }, { "name": "RoutePolicyName", "type": "string", "required": true, "description": "路由策略名。", "example": "TEST" }, { "name": "RoutePolicyEntrySet", "type": "array", "required": false, "description": "路由策略条目列表。", "example": "无", "item_type": "object", "children": [ { "name": "RoutePolicyEntryId", "type": "string", "required": false, "description": "路由策略条目IPv4唯一ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "rrpi-hd7hsfhh" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "目标网段。 注意：此字段可能返回 null，表示取不到有效值。", "example": "13.0.0.0/16" }, { "name": "Description", "type": "string", "required": false, "description": "路由策略规则描述。 注意：此字段可能返回 null，表示取不到有效值。", "example": "demo" }, { "name": "RouteType", "type": "string", "required": false, "description": "路由类型。 USER：用户自定义类型。 NETD：网络探测下发的路由。 CCN：云联网路由。 注意：此字段可能返回 null，表示取不到有效值。", "example": "CCN" }, { "name": "GatewayType", "type": "string", "required": false, "description": "下一跳类型。目前我们支持的类型有： CVM：公网网关类型的云服务器； VPN：VPN网关； DIRECTCONNECT：专线网关； PEERCONNECTION：对等连接； HAVIP：高可用虚拟IP； NAT：NAT网关; EIP：云服务器的公网IP； LOCAL_GATEWAY：本地网关; PVGW：PVGW网关。 注意：此字段可能返回 null，表示取不到有效值。", "example": "CVM" }, { "name": "GatewayId", "type": "string", "required": false, "description": "网关唯一ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "172.16.16.37" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级。数值越小，优先级越高。 注意：此字段可能返回 null，表示取不到有效值。", "example": "100" }, { "name": "Action", "type": "string", "required": false, "description": "动作。 DROP：丢弃。 DISABLE：接收且禁用。 ACCEPT：接收且启用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ACCEPT" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "创建时间。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2023-05-20 15:06:34" }, { "name": "Region", "type": "string", "required": false, "description": "地域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-guangzhou" } ] } ], "required": [ "RoutePolicyDescription", "RoutePolicyName" ] }, { "name": "CreateRoutePolicyAssociations", "description": "本接口（CreateRoutePolicyAssociations）用于创建路由接收策略绑定(路由策略实例和路由表实例的绑定关系以及绑定优先级)。", "status": "online", "parameters": [ { "name": "RoutePolicyAssociationSet", "type": "array", "required": true, "description": "路由接收策略绑定对象列表。", "example": "无", "item_type": "object", "children": [ { "name": "RouteTableId", "type": "string", "required": false, "description": "路由表唯一ID。", "example": "rtb-qk8eyn9g" }, { "name": "RoutePolicyId", "type": "string", "required": false, "description": "路由接收策略唯一ID。", "example": "rrp-r70ctaia" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级。", "example": "100" } ] } ], "required": [ "RoutePolicyAssociationSet" ] }, { "name": "CreateRoutePolicyEntries", "description": "本接口（CreateRoutePolicyEntries）用于创建路由接收策略条目。", "status": "online", "parameters": [ { "name": "RoutePolicyId", "type": "string", "required": true, "description": "路由接收策略实例ID。", "example": "rrp-q7ywkx3w" }, { "name": "RoutePolicyEntrySet", "type": "array", "required": true, "description": "路由接收策略条目列表。", "example": "无", "item_type": "object", "children": [ { "name": "RoutePolicyEntryId", "type": "string", "required": false, "description": "路由策略条目IPv4唯一ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "rrpi-hd7hsfhh" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "目标网段。 注意：此字段可能返回 null，表示取不到有效值。", "example": "13.0.0.0/16" }, { "name": "Description", "type": "string", "required": false, "description": "路由策略规则描述。 注意：此字段可能返回 null，表示取不到有效值。", "example": "demo" }, { "name": "RouteType", "type": "string", "required": false, "description": "路由类型。 USER：用户自定义类型。 NETD：网络探测下发的路由。 CCN：云联网路由。 注意：此字段可能返回 null，表示取不到有效值。", "example": "CCN" }, { "name": "GatewayType", "type": "string", "required": false, "description": "下一跳类型。目前我们支持的类型有： CVM：公网网关类型的云服务器； VPN：VPN网关； DIRECTCONNECT：专线网关； PEERCONNECTION：对等连接； HAVIP：高可用虚拟IP； NAT：NAT网关; EIP：云服务器的公网IP； LOCAL_GATEWAY：本地网关; PVGW：PVGW网关。 注意：此字段可能返回 null，表示取不到有效值。", "example": "CVM" }, { "name": "GatewayId", "type": "string", "required": false, "description": "网关唯一ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "172.16.16.37" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级。数值越小，优先级越高。 注意：此字段可能返回 null，表示取不到有效值。", "example": "100" }, { "name": "Action", "type": "string", "required": false, "description": "动作。 DROP：丢弃。 DISABLE：接收且禁用。 ACCEPT：接收且启用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ACCEPT" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "创建时间。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2023-05-20 15:06:34" }, { "name": "Region", "type": "string", "required": false, "description": "地域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-guangzhou" } ] } ], "required": [ "RoutePolicyId", "RoutePolicyEntrySet" ] }, { "name": "CreateRouteTable", "description": "本接口(CreateRouteTable)用于创建路由表。 * 创建了VPC后，系统会创建一个默认路由表，所有新建的子网都会关联到默认路由表。默认情况下您可以直接使用默认路由表来管理您的路由策略。当您的路由策略较多时，您可以调用创建路由表接口创建更多路由表管理您的路由策略。 * 创建路由表同时可以绑定标签, 应答里的标签列表代表添加成功的标签。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "待操作的VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。", "example": "vpc-2at5y1pn" }, { "name": "RouteTableName", "type": "string", "required": true, "description": "路由表名称，最大长度不能超过60个字节。", "example": "TestRouteTable" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]", "example": "[{'Key': 'Key1', 'Value': 'Value1'}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] } ], "required": [ "VpcId", "RouteTableName" ] }, { "name": "CreateRoutes", "description": "本接口（CreateRoutes）用于创建路由策略。 * 向指定路由表批量新增路由策略。", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表实例ID。", "example": "rtb-n0yejvje" }, { "name": "Routes", "type": "array", "required": true, "description": "路由策略对象。", "example": "[{\"RouteTableId\":\"rtb-n0yejvje\",\"RouteSet\":[{\"RouteItemId\": \"rti-psm73tvu\",\"DestinationCidrBlock\": \"192.168.0.0/16\"}]}]", "item_type": "object", "children": [ { "name": "DestinationCidrBlock", "type": "string", "required": true, "description": "创建IPv4目的网段，取值不能在私有网络网段内，例如：112.20.51.0/24。", "example": "10.0.0.0/24" }, { "name": "GatewayType", "type": "string", "required": true, "description": "下一跳类型，目前我们支持的类型有： CVM：公网网关类型的云服务器； VPN：VPN网关； DIRECTCONNECT：专线网关； PEERCONNECTION：对等连接； HAVIP：高可用虚拟IP； NAT：公网NAT网关; NORMAL_CVM：普通云服务器； EIP：云服务器的公网IP； LOCAL_GATEWAY：CDC本地网关； INTRANAT：私网NAT网关； USER_CCN：云联网（自定义路由）； GWLB_ENDPOINT：网关负载均衡终端节点。", "example": "CCN" }, { "name": "GatewayId", "type": "string", "required": true, "description": "下一跳地址，这里只需要指定不同下一跳类型的网关ID，系统会自动匹配到下一跳地址。 特殊说明： GatewayType为NORMAL_CVM时，GatewayId填写实例的内网IP。 GatewayType为EIP时，GatewayId填写0。", "example": "ccn-e187un9p" }, { "name": "RouteId", "type": "integer", "required": false, "description": "路由策略ID。IPv4路由策略ID是有意义的值，IPv6路由策略是无意义的值0。后续建议完全使用字符串唯一ID `RouteItemId`操作路由策略。 该字段在删除时必填，其他字段无需填写。", "example": "1289089" }, { "name": "RouteDescription", "type": "string", "required": false, "description": "路由策略描述。", "example": "demo" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否启用", "example": "true" }, { "name": "RouteType", "type": "string", "required": false, "description": "路由类型，目前我们支持的类型有： USER：用户路由； NETD：网络探测路由，创建网络探测实例时，系统默认下发，不可编辑与删除； CCN：云联网路由，系统默认下发，不可编辑与删除。 用户只能添加和操作 USER 类型的路由。", "example": "CCN" }, { "name": "RouteTableId", "type": "string", "required": false, "description": "路由表实例ID，例如：rtb-azd4dt1c。", "example": "rtb-azd4dt1c" }, { "name": "DestinationIpv6CidrBlock", "type": "string", "required": false, "description": "创建IPv6目的网段，取值不能在私有网络网段内，例如：2402:4e00:1000:810b::/64。", "example": "3402:4e00:20:1200::/56" }, { "name": "RouteItemId", "type": "string", "required": false, "description": "路由唯一策略ID。", "example": "rti-9bjer08h" }, { "name": "PublishedToVbc", "type": "boolean", "required": false, "description": "路由策略是否发布到云联网。该字段仅做出参使用，作为入参字段时此参数不生效。", "example": "true" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "路由策略创建时间", "example": "2021-03-02 14:41:15" }, { "name": "CdcId", "type": "string", "required": false, "description": "CDC 集群唯一 ID。", "example": "cluster-d8htgb6k" } ] } ], "required": [ "RouteTableId", "Routes" ] }, { "name": "CreateSecurityGroup", "description": "本接口（CreateSecurityGroup）用于创建新的安全组（SecurityGroup）。 * 每个账户下每个地域的每个项目的安全组数量限制。 * 新建的安全组的入站和出站规则默认都是全部拒绝，在创建后通常您需要再调用CreateSecurityGroupPolicies将安全组的规则设置为需要的规则。 * 创建安全组同时可以绑定标签, 应答里的标签列表代表添加成功的标签。", "status": "online", "parameters": [ { "name": "GroupName", "type": "string", "required": true, "description": "安全组名称，可任意命名，但不得超过60个字符。", "example": "TestGroup" }, { "name": "GroupDescription", "type": "string", "required": true, "description": "安全组备注，最多100个字符。", "example": "test-group-desc" }, { "name": "ProjectId", "type": "string", "required": false, "description": "项目ID，默认0。可在控制台项目管理页面查询到。", "example": "0" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] } ], "required": [ "GroupName", "GroupDescription" ] }, { "name": "CreateSecurityGroupPolicies", "description": "本接口（CreateSecurityGroupPolicies）用于创建安全组规则（SecurityGroupPolicy）。 在 SecurityGroupPolicySet 参数中： Version 安全组规则版本号，用户每次更新安全规则版本会自动加1，防止您更新的路由规则已过期，不填不考虑冲突。 在创建出站和入站规则（Egress 和 Ingress）时： Protocol 字段支持输入TCP, UDP, ICMP, ICMPV6, GRE, ALL。 CidrBlock 字段允许输入符合cidr格式标准的任意字符串。在基础网\ufffd...", "status": "online", "parameters": [ { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组实例ID，例如sg-33ocnj9n，可通过DescribeSecurityGroups获取。", "example": "sg-33ocnj9n" }, { "name": "SecurityGroupPolicySet", "type": "object", "required": true, "description": "安全组规则集合。", "example": "{\"Ingress\": [{\"Protocol\": \"TCP\", \"Port\": \"8080\", \"Action\": \"ACCEPT\", \"CidrBlock\": \"10.0.0.0/24\", \"PolicyIndex\": \"0\"}]}", "children": [ { "name": "Version", "type": "string", "required": false, "description": "安全组规则当前版本。用户每次更新安全规则版本会自动加1，防止更新的路由规则已过期，不填不考虑冲突。", "example": "10" }, { "name": "Egress", "type": "array", "required": false, "description": "出站规则。", "example": "[{\"PolicyIndex\": 0, \"Port\": \"443\", \"CidrBlock\": \"10.0.0.0/24\", \"Action\": \"ACCEPT\", \"ModifyTime\": \"2020-10-09 10:00:00\", \"PolicyDescription\": \"\", \"Protocol\": \"tcp\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号，值会随着安全组规则的变更动态变化。使用PolicyIndex时，请先调用`DescribeSecurityGroupPolicies`获取到规则的PolicyIndex，并且结合返回值中的Version一起使用处理规则。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP,ICMP,ICMPv6,ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。 说明：如果Protocol设置为ALL，则Port也需要设置为all。", "example": "22" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "ppm-8g7k5qfq", "children": [ { "name": "ServiceId", "type": "string", "required": false, "description": "协议端口ID，例如：ppm-f5n1f8da。", "example": "ppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": false, "description": "协议端口组ID，例如：ppmg-f5n1f8da。", "example": "ppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)，特殊说明：0.0.0.0/n 都会映射为0.0.0.0/0。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IP地址。", "example": "10.0.0.0/16" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IPv6地址。", "example": "::/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：sg-ohuuioma。", "example": "sg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者IP地址组ID。", "example": "ipm-p5sf61yj", "children": [ { "name": "AddressId", "type": "string", "required": false, "description": "IP地址ID，例如：ipm-2uw6ujo6。", "example": "ipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": false, "description": "IP地址组ID，例如：ipmg-2uw6ujo6。", "example": "ipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。作为入参时，当未传递该参数或值为空，且参数CidrBlock或Ipv6CidrBlock值为MY_PUBLIC_IP时，该参数的值将会被自动填充为Replaced-From-MY_PUBLIC_IP。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "安全组最近修改时间。", "example": "2021-03-02 14:41:15" }, { "name": "Priority", "type": "integer", "required": false, "description": "安全组规则优先级，值会随着安全组规则的变更动态变化。使用Priority时，请先调用`DescribeSecurityGroupPolicies`获取到规则的Priority，并且结合返回值中的Version一起使用处理规则。" } ] }, { "name": "Ingress", "type": "array", "required": false, "description": "入站规则。", "example": "[{\"PolicyIndex\": 0, \"Port\": \"443\", \"CidrBlock\": \"0.0.0.0/0\", \"Action\": \"ACCEPT\", \"ModifyTime\": \"2020-10-09 10:00:00\", \"PolicyDescription\": \"\", \"Protocol\": \"tcp\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号，值会随着安全组规则的变更动态变化。使用PolicyIndex时，请先调用`DescribeSecurityGroupPolicies`获取到规则的PolicyIndex，并且结合返回值中的Version一起使用处理规则。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP,ICMP,ICMPv6,ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。 说明：如果Protocol设置为ALL，则Port也需要设置为all。", "example": "22" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "ppm-8g7k5qfq", "children": [ { "name": "ServiceId", "type": "string", "required": false, "description": "协议端口ID，例如：ppm-f5n1f8da。", "example": "ppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": false, "description": "协议端口组ID，例如：ppmg-f5n1f8da。", "example": "ppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)，特殊说明：0.0.0.0/n 都会映射为0.0.0.0/0。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IP地址。", "example": "10.0.0.0/16" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IPv6地址。", "example": "::/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：sg-ohuuioma。", "example": "sg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者IP地址组ID。", "example": "ipm-p5sf61yj", "children": [ { "name": "AddressId", "type": "string", "required": false, "description": "IP地址ID，例如：ipm-2uw6ujo6。", "example": "ipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": false, "description": "IP地址组ID，例如：ipmg-2uw6ujo6。", "example": "ipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。作为入参时，当未传递该参数或值为空，且参数CidrBlock或Ipv6CidrBlock值为MY_PUBLIC_IP时，该参数的值将会被自动填充为Replaced-From-MY_PUBLIC_IP。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "安全组最近修改时间。", "example": "2021-03-02 14:41:15" }, { "name": "Priority", "type": "integer", "required": false, "description": "安全组规则优先级，值会随着安全组规则的变更动态变化。使用Priority时，请先调用`DescribeSecurityGroupPolicies`获取到规则的Priority，并且结合返回值中的Version一起使用处理规则。" } ] }, { "name": "PolicyStatistics", "type": "object", "required": false, "description": "安全组策略条目统计。只用于出参。", "example": "{\"IngressIPv4TotalCount\": 1, \"IngressIPv6TotalCount\": 0, \"EgressIPv4TotalCount\": 1, \"EgressIPv6TotalCount\": 0}", "children": [ { "name": "IngressIPv4TotalCount", "type": "integer", "required": true, "description": "入站IPv4总数", "example": "1" }, { "name": "IngressIPv6TotalCount", "type": "integer", "required": true, "description": "入站IPv6总数", "example": "1" }, { "name": "EgressIPv4TotalCount", "type": "integer", "required": true, "description": "出站IPv4总数", "example": "1" }, { "name": "EgressIPv6TotalCount", "type": "integer", "required": true, "description": "出站IPv6总数", "example": "1" } ] } ] } ], "required": [ "SecurityGroupId", "SecurityGroupPolicySet" ] }, { "name": "CreateSecurityGroupWithPolicies", "description": "本接口（CreateSecurityGroupWithPolicies）用于创建新的安全组（SecurityGroup），并且可以同时添加安全组规则（SecurityGroupPolicy）。 * 每个账户下每个地域的每个项目的安全组数量限制。 * 新建的安全组的入站和出站规则默认都是全部拒绝，在创建后通常您需要再调用CreateSecurityGroupPolicies 将安全组的规则设置为需要的规则。 安全组规则说明： * Version安全组规则版本号，用户每次更新\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "GroupName", "type": "string", "required": true, "description": "安全组名称，可任意命名，但不得超过60个字符。", "example": "demo" }, { "name": "GroupDescription", "type": "string", "required": true, "description": "安全组备注，最多100个字符。", "example": "demo" }, { "name": "ProjectId", "type": "string", "required": false, "description": "项目ID，默认0。可在控制台项目管理页面查询到。", "example": "1" }, { "name": "SecurityGroupPolicySet", "type": "object", "required": false, "description": "安全组规则集合。", "example": "{\"Version\": \"124\", \"Egress\": [], \"Ingress\": []}", "children": [ { "name": "Version", "type": "string", "required": false, "description": "安全组规则当前版本。用户每次更新安全规则版本会自动加1，防止更新的路由规则已过期，不填不考虑冲突。", "example": "10" }, { "name": "Egress", "type": "array", "required": false, "description": "出站规则。", "example": "[{\"PolicyIndex\": 0, \"Port\": \"443\", \"CidrBlock\": \"10.0.0.0/24\", \"Action\": \"ACCEPT\", \"ModifyTime\": \"2020-10-09 10:00:00\", \"PolicyDescription\": \"\", \"Protocol\": \"tcp\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号，值会随着安全组规则的变更动态变化。使用PolicyIndex时，请先调用`DescribeSecurityGroupPolicies`获取到规则的PolicyIndex，并且结合返回值中的Version一起使用处理规则。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP,ICMP,ICMPv6,ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。 说明：如果Protocol设置为ALL，则Port也需要设置为all。", "example": "22" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "ppm-8g7k5qfq", "children": [ { "name": "ServiceId", "type": "string", "required": false, "description": "协议端口ID，例如：ppm-f5n1f8da。", "example": "ppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": false, "description": "协议端口组ID，例如：ppmg-f5n1f8da。", "example": "ppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)，特殊说明：0.0.0.0/n 都会映射为0.0.0.0/0。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IP地址。", "example": "10.0.0.0/16" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IPv6地址。", "example": "::/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：sg-ohuuioma。", "example": "sg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者IP地址组ID。", "example": "ipm-p5sf61yj", "children": [ { "name": "AddressId", "type": "string", "required": false, "description": "IP地址ID，例如：ipm-2uw6ujo6。", "example": "ipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": false, "description": "IP地址组ID，例如：ipmg-2uw6ujo6。", "example": "ipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。作为入参时，当未传递该参数或值为空，且参数CidrBlock或Ipv6CidrBlock值为MY_PUBLIC_IP时，该参数的值将会被自动填充为Replaced-From-MY_PUBLIC_IP。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "安全组最近修改时间。", "example": "2021-03-02 14:41:15" }, { "name": "Priority", "type": "integer", "required": false, "description": "安全组规则优先级，值会随着安全组规则的变更动态变化。使用Priority时，请先调用`DescribeSecurityGroupPolicies`获取到规则的Priority，并且结合返回值中的Version一起使用处理规则。" } ] }, { "name": "Ingress", "type": "array", "required": false, "description": "入站规则。", "example": "[{\"PolicyIndex\": 0, \"Port\": \"443\", \"CidrBlock\": \"0.0.0.0/0\", \"Action\": \"ACCEPT\", \"ModifyTime\": \"2020-10-09 10:00:00\", \"PolicyDescription\": \"\", \"Protocol\": \"tcp\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号，值会随着安全组规则的变更动态变化。使用PolicyIndex时，请先调用`DescribeSecurityGroupPolicies`获取到规则的PolicyIndex，并且结合返回值中的Version一起使用处理规则。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP,ICMP,ICMPv6,ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。 说明：如果Protocol设置为ALL，则Port也需要设置为all。", "example": "22" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "ppm-8g7k5qfq", "children": [ { "name": "ServiceId", "type": "string", "required": false, "description": "协议端口ID，例如：ppm-f5n1f8da。", "example": "ppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": false, "description": "协议端口组ID，例如：ppmg-f5n1f8da。", "example": "ppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)，特殊说明：0.0.0.0/n 都会映射为0.0.0.0/0。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IP地址。", "example": "10.0.0.0/16" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IPv6地址。", "example": "::/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：sg-ohuuioma。", "example": "sg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者IP地址组ID。", "example": "ipm-p5sf61yj", "children": [ { "name": "AddressId", "type": "string", "required": false, "description": "IP地址ID，例如：ipm-2uw6ujo6。", "example": "ipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": false, "description": "IP地址组ID，例如：ipmg-2uw6ujo6。", "example": "ipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。作为入参时，当未传递该参数或值为空，且参数CidrBlock或Ipv6CidrBlock值为MY_PUBLIC_IP时，该参数的值将会被自动填充为Replaced-From-MY_PUBLIC_IP。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "安全组最近修改时间。", "example": "2021-03-02 14:41:15" }, { "name": "Priority", "type": "integer", "required": false, "description": "安全组规则优先级，值会随着安全组规则的变更动态变化。使用Priority时，请先调用`DescribeSecurityGroupPolicies`获取到规则的Priority，并且结合返回值中的Version一起使用处理规则。" } ] }, { "name": "PolicyStatistics", "type": "object", "required": false, "description": "安全组策略条目统计。只用于出参。", "example": "{\"IngressIPv4TotalCount\": 1, \"IngressIPv6TotalCount\": 0, \"EgressIPv4TotalCount\": 1, \"EgressIPv6TotalCount\": 0}", "children": [ { "name": "IngressIPv4TotalCount", "type": "integer", "required": true, "description": "入站IPv4总数", "example": "1" }, { "name": "IngressIPv6TotalCount", "type": "integer", "required": true, "description": "入站IPv6总数", "example": "1" }, { "name": "EgressIPv4TotalCount", "type": "integer", "required": true, "description": "出站IPv4总数", "example": "1" }, { "name": "EgressIPv6TotalCount", "type": "integer", "required": true, "description": "出站IPv6总数", "example": "1" } ] } ] }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", "example": "[{\"Key\": \"env\", \"Value\": \"prod\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] } ], "required": [ "GroupName", "GroupDescription" ] }, { "name": "CreateServiceTemplate", "description": "本接口（CreateServiceTemplate）用于创建协议端口模板。", "status": "online", "parameters": [ { "name": "ServiceTemplateName", "type": "string", "required": true, "description": "协议端口模板名称。", "example": "demo" }, { "name": "Services", "type": "array", "required": false, "description": "支持单个端口、多个端口、连续端口及所有端口，协议支持：TCP、UDP、ICMP、GRE 协议。Services与ServicesExtra必填其一。", "example": "[\"TCP:8080\",\"UDP:99\"]", "item_type": "string" }, { "name": "ServicesExtra", "type": "array", "required": false, "description": "支持添加备注，单个端口、多个端口、连续端口及所有端口，协议支持：TCP、UDP、ICMP、GRE 协议。Services与ServicesExtra必填其一。", "example": "[{\"Service\": \"TCP:8080\"}]", "item_type": "object", "children": [ { "name": "Service", "type": "string", "required": true, "description": "协议端口。", "example": "tcp:80" }, { "name": "Description", "type": "string", "required": false, "description": "备注。", "example": "desc" }, { "name": "UpdatedTime", "type": "string", "required": false, "description": "更新时间。", "example": "2020-08-10 18:10:12" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", "example": "[{\"Key\": \"env\", \"Value\": \"prod\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] } ], "required": [ "ServiceTemplateName" ] }, { "name": "CreateServiceTemplateGroup", "description": "本接口（CreateServiceTemplateGroup）用于创建协议端口模板集合。", "status": "online", "parameters": [ { "name": "ServiceTemplateGroupName", "type": "string", "required": true, "description": "协议端口模板集合名称。", "example": "demo" }, { "name": "ServiceTemplateIds", "type": "array", "required": true, "description": "协议端口模板实例ID，例如：ppm-4dw6agho。", "example": "ppm-4dw6agho", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", "example": "[{\"Key\": \"env\", \"Value\": \"prod\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] } ], "required": [ "ServiceTemplateGroupName", "ServiceTemplateIds" ] }, { "name": "CreateSnapshotPolicies", "description": "本接口（CreateSnapshotPolicies）用于创建快照策略。", "status": "online", "parameters": [ { "name": "SnapshotPolicies", "type": "array", "required": true, "description": "快照策略详情。", "example": "无", "item_type": "object", "children": [ { "name": "SnapshotPolicyName", "type": "string", "required": true, "description": "快照策略名称。", "example": "demo" }, { "name": "BackupType", "type": "string", "required": true, "description": "备份策略类型，operate-操作备份，time-定时备份。", "example": "time" }, { "name": "KeepTime", "type": "integer", "required": true, "description": "保留时间，支持1～365天。", "example": "12" }, { "name": "CreateNewCos", "type": "boolean", "required": true, "description": "是否创建新的cos桶，默认为False。", "example": "true" }, { "name": "CosRegion", "type": "string", "required": true, "description": "cos桶所在地域。", "example": "ap-guangzhou" }, { "name": "CosBucket", "type": "string", "required": true, "description": "cos桶。", "example": "cos-nswq8wkq" }, { "name": "SnapshotPolicyId", "type": "string", "required": false, "description": "快照策略Id。", "example": "sspolicy-hx8an9sr" }, { "name": "BackupPolicies", "type": "array", "required": false, "description": "时间备份策略。", "example": "[{\"BackupDay\": \"monday\", \"BackupTime\": \"3:00\"}]", "item_type": "object", "children": [ { "name": "BackupDay", "type": "string", "required": true, "description": "备份周期时间，取值为monday, tuesday, wednesday, thursday, friday, saturday, sunday。", "example": "monday" }, { "name": "BackupTime", "type": "string", "required": true, "description": "备份时间点，格式：HH:mm:ss。", "example": "3:00" } ] }, { "name": "Enable", "type": "boolean", "required": false, "description": "启用状态，True-启用，False-停用，默认为True。", "example": "true" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间。", "example": "2021-03-02 14:41:15" }, { "name": "TagSet", "type": "array", "required": false, "description": "标签键值对。", "example": "[{\"Key\": \"env\", \"Value\": \"prod\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] } ] }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] } ], "required": [ "SnapshotPolicies" ] }, { "name": "CreateSubnet", "description": "本接口（CreateSubnet）用于创建子网。 * 创建子网前必须创建好 VPC。 * 子网创建成功后，子网网段不能修改。子网网段必须在VPC网段内，可以和VPC网段相同（VPC有且只有一个子网时），建议子网网段在VPC网段内，预留网段给其他子网使用。 * 您可以创建的最小网段子网掩码为28（有16个IP地址），最大网段子网掩码为16（65,536个IP地址）。 * 同一个VPC内，多个子网的网段不能重叠。...", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "待操作的VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。", "example": "vpc-m3ul053f" }, { "name": "SubnetName", "type": "string", "required": true, "description": "子网名称，最大长度不能超过60个字节。", "example": "demo" }, { "name": "CidrBlock", "type": "string", "required": true, "description": "子网网段，子网网段必须在VPC网段内，相同VPC内子网网段不能重叠。", "example": "10.8.0.0/16" }, { "name": "Zone", "type": "string", "required": true, "description": "子网所在的可用区ID，不同子网选择不同可用区可以做跨可用区灾备。", "example": "ap-guangzhou-1" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] }, { "name": "CdcId", "type": "string", "required": false, "description": "CDC实例ID。", "example": "cluster-gbo27yc4" } ], "required": [ "VpcId", "SubnetName", "CidrBlock", "Zone" ] }, { "name": "CreateSubnets", "description": "本接口（CreateSubnets）用于批量创建子网。 * 创建子网前必须创建好 VPC。 * 子网创建成功后，子网网段不能修改。子网网段必须在VPC网段内，可以和VPC网段相同（VPC有且只有一个子网时），建议子网网段在VPC网段内，预留网段给其他子网使用。 * 您可以创建的最小网段子网掩码为28（有16个IP地址），最大网段子网掩码为16（65,536个IP地址）。 * 同一个VPC内，多个子网的网段不能\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "`VPC`实例`ID`。形如：`vpc-6v2ht8q5`。", "example": "vpc-6v2ht8q5" }, { "name": "Subnets", "type": "array", "required": true, "description": "子网对象列表。", "example": "无", "item_type": "object", "children": [ { "name": "CidrBlock", "type": "string", "required": true, "description": "子网的`CIDR`。", "example": "10.0.0.0/24" }, { "name": "SubnetName", "type": "string", "required": true, "description": "子网名称。", "example": "demo" }, { "name": "Zone", "type": "string", "required": true, "description": "可用区。形如：`ap-guangzhou-2`。", "example": "ap-guangzhou-2" }, { "name": "RouteTableId", "type": "string", "required": false, "description": "指定关联路由表，形如：`rtb-3ryrwzuu`。", "example": "rtb-h0fk8lfc" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，注意这里的标签集合为列表中所有子网对象所共享，不能为每个子网对象单独指定标签，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] }, { "name": "CdcId", "type": "string", "required": false, "description": "需要增加到的CDC实例ID。", "example": "cluster-gbo27yc4" } ], "required": [ "VpcId", "Subnets" ] }, { "name": "CreateTrafficMirror", "description": "本接口（CreateTrafficMirror）用于创建流量镜像实例。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC实例ID。", "example": "vpc-39lpx32d" }, { "name": "TrafficMirrorName", "type": "string", "required": true, "description": "流量镜像名字。", "example": "demo" }, { "name": "TrafficMirrorDescribe", "type": "string", "required": false, "description": "流量镜像描述。", "example": "demo" }, { "name": "State", "type": "string", "required": false, "description": "流量镜像状态, 支持RUNNING/STOPED（vpc），RUNNING（公网IP），当采集vpc流量镜像时，此参数为必填。", "example": "RUNNING" }, { "name": "Direction", "type": "string", "required": false, "description": "流量镜像采集方向，支持EGRESS/INGRESS/ALL（vpc），ALL（公网IP）。", "example": "EGRESS" }, { "name": "CollectorSrcs", "type": "array", "required": false, "description": "流量镜像的采集对象。", "example": "[\"vpc-39lpv32n\"]", "item_type": "string" }, { "name": "NatId", "type": "string", "required": false, "description": "流量镜像过滤的natgw实例。", "example": "nat-qo7kugz0" }, { "name": "CollectorNormalFilters", "type": "array", "required": false, "description": "需要过滤的五元组规则。", "example": "无", "item_type": "object", "children": [ { "name": "SrcNet", "type": "string", "required": true, "description": "过滤规则的源网段", "example": "10.0.0.0/24" }, { "name": "DstNet", "type": "string", "required": true, "description": "过滤规则的目的网段", "example": "192.168.0.0/24" }, { "name": "Protocol", "type": "string", "required": true, "description": "过滤规则的协议", "example": "ALL" }, { "name": "SrcPort", "type": "string", "required": false, "description": "过滤规则的源端口，默认值1-65535", "example": "5000" }, { "name": "DstPort", "type": "string", "required": false, "description": "过滤规则的目的端口，默认值1-65535", "example": "3456" } ] }, { "name": "CollectorTarget", "type": "object", "required": false, "description": "流量镜像的目的地址。", "example": "无", "children": [ { "name": "TargetIps", "type": "array", "required": false, "description": "流量镜像的接收IP", "example": "[\"10.0.0.0\"]", "item_type": "string" }, { "name": "AlgHash", "type": "string", "required": false, "description": "流量镜像接收IP组，均衡规则，支持ENI/FIVE_TUPLE_FLOW（vpc），FIVE_TUPLE_FLOW（公网IP）", "example": "FIVE_TUPLE_FLOW" }, { "name": "TargetEndPoints", "type": "array", "required": false, "description": "流量镜像的接收endpoint（公网IP）", "example": "10.0.0.0", "item_type": "string" }, { "name": "TargetType", "type": "string", "required": false, "description": "流量镜像的接收类型，分别为：IP/ENI/CLB", "example": "IP" } ] }, { "name": "SubnetId", "type": "string", "required": false, "description": "流量镜像采集流量的发送端所属子网ID。", "example": "subnet-iamq13a" }, { "name": "Type", "type": "string", "required": false, "description": "创建的流量镜像的类型，支持VPC/PUBLICIP，默认为VPC类型。", "example": "VPC" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", "example": "[{\"Key\": \"city\", \"Value\": \"shanghai\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] } ], "required": [ "VpcId", "TrafficMirrorName" ] }, { "name": "CreateTrafficPackages", "description": "本接口 (CreateTrafficPackages) 用于创建共享流量包。", "status": "online", "parameters": [ { "name": "TrafficAmount", "type": "integer", "required": true, "description": "流量包规格。可选值: 10: 10GB流量，有效期一个月 50: 50GB流量，有效期一个月 512: 512GB流量，有效期一个月 1024: 1TB流量，有效期一个月 5120: 5TB流量，有效期一个月 51200: 50TB流量，有效期一个月 60: 60GB流量，有效期半年 300: 300GB流量，有效期半年 3072: 3TB流量，有效期半年 6144: 6TB流量，有效期半年 30720: 30TB流量，有效期半年 61440: 60TB流量，有效期半年 307200: 300TB流量，有效期半年", "example": "10" }, { "name": "TrafficPackageCount", "type": "integer", "required": false, "description": "流量包数量，可选范围 1~20。", "example": "1" }, { "name": "DeductType", "type": "string", "required": false, "description": "抵扣类型，默认为 FULL_TIME，可选值: FULL_TIME: 全时流量包 IDLE_TIME: 闲时流量包", "example": "FULL_TIME" } ], "required": [ "TrafficAmount" ] }, { "name": "CreateVpc", "description": "本接口（CreateVpc）用于创建私有网络（VPC）。 * 用户可以创建的最小网段子网掩码为28（有16个IP地址），10.0.0.0/12，172.16.0.0/12最大网段子网掩码为12（1,048,576个IP地址），192.168.0.0/16最大网段子网掩码为16（65,536个IP地址）如果需要规划VPC网段请参见[网络规划](https://cloud.tencent.com/document/product/215/30313)。 * 同一个地域能创建的VPC资源个数也是有限制的，详见 VPC使用限制，如果需要\ufffd...", "status": "online", "parameters": [ { "name": "VpcName", "type": "string", "required": true, "description": "vpc名称，最大长度不能超过60个字节。", "example": "TestVPC" }, { "name": "CidrBlock", "type": "string", "required": true, "description": "vpc的cidr，仅能在10.0.0.0/12，172.16.0.0/12，192.168.0.0/16这三个内网网段内。", "example": "10.8.0.0/16" }, { "name": "EnableMulticast", "type": "string", "required": false, "description": "是否开启组播。true: 开启, false: 不开启。", "example": "true" }, { "name": "DnsServers", "type": "array", "required": false, "description": "DNS地址，最多支持4个。", "example": "[\"183.60.83.19\"]", "item_type": "string" }, { "name": "DomainName", "type": "string", "required": false, "description": "DHCP使用的域名。", "example": "demo" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] }, { "name": "EnableRouteVpcPublish", "type": "boolean", "required": false, "description": "vpc关联云联网时路由发布策略， true：开启cidr路由发布，false：开启subnet子网路由发布。创建vpc时默认为子网路由发布，当选择cidr路由发布时,请通过工单加入白名单", "example": "true" }, { "name": "EnableRouteVpcPublishIpv6", "type": "boolean", "required": false, "description": "vpc关联云联网时IPv6类型路由发布策略， true：开启cidr路由发布，false：开启subnet子网路由发布。创建vpc时默认为子网路由发布，当选择cidr路由发布时，请通过工单加入白名单。", "example": "false" } ], "required": [ "VpcName", "CidrBlock" ] }, { "name": "CreateVpcEndPoint", "description": "本接口（CreateVpcEndPoint）用于创建终端节点。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC实例ID。可通过[DescribeVpcs](https://cloud.tencent.com/document/product/1108/43663)接口获取。", "example": "vpc-q26u781x。" }, { "name": "SubnetId", "type": "string", "required": true, "description": "子网实例ID。可通过[DescribeSubnets](https://cloud.tencent.com/document/product/215/15784)接口获取。", "example": "subnet-qmqye6ew。" }, { "name": "EndPointName", "type": "string", "required": true, "description": "终端节点名称。限制为60个字符。", "example": "EndPointName1。" }, { "name": "EndPointServiceId", "type": "string", "required": true, "description": "终端节点服务ID。可通过[DescribeVpcEndPointService](https://cloud.tencent.com/document/product/215/54678)接口获取。", "example": "vpcsvc-ettmyyrn。" }, { "name": "EndPointVip", "type": "string", "required": false, "description": "终端节点VIP，可以指定IP申请。", "example": "10.0.0.0/16。" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组ID。可通过[DescribeSecurityGroups](https://cloud.tencent.com/document/product/215/15808)接口获取。", "example": "sg-123456。" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", "example": "[{\"Key\": \"env\", \"Value\": \"prod\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] }, { "name": "IpAddressType", "type": "string", "required": false, "description": "协议类型，支持 Ipv4，Ipv6，默认 Ipv4", "example": "Ipv4" } ], "required": [ "VpcId", "SubnetId", "EndPointName", "EndPointServiceId" ] }, { "name": "CreateVpcEndPointService", "description": "本接口（CreateVpcEndPointService）用于创建终端节点服务。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC实例ID。可通过[DescribeVpcs](https://cloud.tencent.com/document/product/1108/43663)接口获取。", "example": "vpc-ihwh81fr" }, { "name": "EndPointServiceName", "type": "string", "required": true, "description": "终端节点服务名称。", "example": "EndPointServiceName1" }, { "name": "AutoAcceptFlag", "type": "boolean", "required": true, "description": "是否自动接受。", "example": "true" }, { "name": "ServiceInstanceId", "type": "string", "required": true, "description": "后端服务ID，比如lb-p1hiksdg。CLB可通过[DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459)接口获取；CDB可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/240/38568)接口获取；CRS可通过[DescribeInstances](https://cloud.tencent.com/document/product/239/20018)接口获取；GWLB可通过[DescribeGatewayLoadBalancers](https://cloud.tencent.com/document/product/1782/111683)接口获取。", "example": "lb-7xwasqqy" }, { "name": "ServiceType", "type": "string", "required": false, "description": "挂载的PAAS服务类型，CLB（负载均衡），CDB（云数据库 MySQL），CRS（云数据库 Redis），GWLB（网关负载均衡）。不填默认挂载为CLB。", "example": "CLB" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", "example": "[{\"Key\": \"env\", \"Value\": \"prod\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] }, { "name": "IpAddressType", "type": "string", "required": false, "description": "协议类型，支持 Ipv4，Ipv6，默认 Ipv4。", "example": "Ipv4" } ], "required": [ "VpcId", "EndPointServiceName", "AutoAcceptFlag", "ServiceInstanceId" ] }, { "name": "CreateVpcEndPointServiceWhiteList", "description": "本接口（CreateVpcEndPointServiceWhiteList）创建终端服务白名单。", "status": "online", "parameters": [ { "name": "UserUin", "type": "string", "required": true, "description": "UIN。腾讯云账号中心控制台获取。", "example": "700000483554" }, { "name": "EndPointServiceId", "type": "string", "required": true, "description": "终端节点服务ID。可通过[DescribeVpcEndPointService](https://cloud.tencent.com/document/product/215/54678)接口获取。", "example": "vpcsvc-b2mrmmx7" }, { "name": "Description", "type": "string", "required": false, "description": "白名单描述。长度不超过60个字符。", "example": "Description1" } ], "required": [ "UserUin", "EndPointServiceId" ] }, { "name": "CreateVpcPeeringConnection", "description": "本接口（CreateVpcPeeringConnection）用于创建私有网络对等连接。", "status": "online", "parameters": [ { "name": "SourceVpcId", "type": "string", "required": true, "description": "本端VPC唯一ID。", "example": "vpc-0npfx81k" }, { "name": "PeeringConnectionName", "type": "string", "required": true, "description": "对等连接名称。", "example": "pcx-1sqw346v" }, { "name": "DestinationVpcId", "type": "string", "required": true, "description": "对端VPC唯一ID。", "example": "vpc-12345678" }, { "name": "DestinationUin", "type": "string", "required": true, "description": "对端用户UIN。", "example": "568722665" }, { "name": "DestinationRegion", "type": "string", "required": true, "description": "对端地域。", "example": "ap-guangzhou" }, { "name": "Bandwidth", "type": "integer", "required": false, "description": "带宽上限，单位Mbps。", "example": "10" }, { "name": "Type", "type": "string", "required": false, "description": "互通类型，VPC_PEER：VPC间互通；VPC_BM_PEER：VPC与黑石网络互通。", "example": "VPC_PEER" }, { "name": "ChargeType", "type": "string", "required": false, "description": "计费模式，日峰值POSTPAID_BY_DAY_MAX，月95POSTPAID_BY_MONTH_95。", "example": "POSTPAID_BY_DAY_MAX" }, { "name": "QosLevel", "type": "string", "required": false, "description": "服务分级：PT、AU、AG。", "example": "PT" }, { "name": "Tags", "type": "array", "required": false, "description": "标签键值对", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": false, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] } ], "required": [ "SourceVpcId", "PeeringConnectionName", "DestinationVpcId", "DestinationUin", "DestinationRegion" ] }, { "name": "CreateVpnConnection", "description": "本接口（CreateVpnConnection）用于创建VPN通道。 \u003e?本接口为异步接口，可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果，待任务执行成功后再进行其他操作。 \u003e", "status": "online", "parameters": [ { "name": "VpnGatewayId", "type": "string", "required": true, "description": "VPN网关实例ID。", "example": "vpngw-1w9tue3d" }, { "name": "CustomerGatewayId", "type": "string", "required": true, "description": "对端网关ID。例如：cgw-2wqq41m9，可通过[DescribeCustomerGateways](https://cloud.tencent.com/document/product/215/17516)接口查询对端网关。", "example": "cgw-qa9sxpy7" }, { "name": "VpnConnectionName", "type": "string", "required": true, "description": "通道名称，可任意命名，但不得超过60个字符。", "example": "TEST_CONN" }, { "name": "PreShareKey", "type": "string", "required": true, "description": "预共享密钥。", "example": "654321" }, { "name": "VpcId", "type": "string", "required": false, "description": "VPC实例ID。可通过[DescribeVpcs](https://cloud.tencent.com/document/product/215/15778)接口返回值中的VpcId获取。 CCN VPN 形的通道 可以不传VPCID", "example": "vpc-gapcv96p" }, { "name": "SecurityPolicyDatabases", "type": "array", "required": false, "description": "SPD策略组，例如：{\"10.0.0.5/24\":[\"172.123.10.5/16\"]}，10.0.0.5/24是vpc内网段172.123.10.5/16是IDC网段。用户指定VPC内哪些网段可以和您IDC中哪些网段通信。", "example": "[{'LocalCidrBlock': '10.40.1.12/24', 'RemoteCidrBlock': ['172.123.10.5/16', '10.7.10.0/16']}]", "item_type": "object", "children": [ { "name": "LocalCidrBlock", "type": "string", "required": true, "description": "本端网段", "example": "10.40.1.12/24" }, { "name": "RemoteCidrBlock", "type": "array", "required": true, "description": "对端网段", "example": "['172.123.10.5/16', '10.7.10.0/16']", "item_type": "string" } ] }, { "name": "IKEOptionsSpecification", "type": "object", "required": false, "description": "IKE配置（Internet Key Exchange，因特网密钥交换），IKE具有一套自我保护机制，用户配置网络安全协议", "example": "{'LocalIdentity': 'ADDRESS', 'LocalAddress': 'dddd'}", "children": [ { "name": "PropoEncryAlgorithm", "type": "string", "required": false, "description": "加密算法，可选值：'3DES-CBC', 'AES-CBC-128', 'AES-CBC-192', 'AES-CBC-256', 'DES-CBC'，'SM4', 默认为3DES-CBC", "example": "3DES-CBC" }, { "name": "PropoAuthenAlgorithm", "type": "string", "required": false, "description": "认证算法：可选值：'MD5'，'SHA'，'SHA-256'，'SHA-512'， 默认为SHA。", "example": "MD5" }, { "name": "ExchangeMode", "type": "string", "required": false, "description": "协商模式：可选值：'AGGRESSIVE'， 'MAIN'，默认为MAIN。", "example": "MAIN" }, { "name": "LocalIdentity", "type": "string", "required": false, "description": "本端标识类型：可选值：'ADDRESS', 'FQDN'，默认为ADDRESS", "example": "ADDRESS" }, { "name": "RemoteIdentity", "type": "string", "required": false, "description": "对端标识类型：可选值：'ADDRESS', 'FQDN'，默认为ADDRESS", "example": "ADDRESS" }, { "name": "LocalAddress", "type": "string", "required": false, "description": "本端标识，当LocalIdentity选为ADDRESS时，LocalAddress必填。localAddress默认为vpn网关公网IP", "example": "1.2.3.4" }, { "name": "RemoteAddress", "type": "string", "required": false, "description": "对端标识，当RemoteIdentity选为ADDRESS时，RemoteAddress必填", "example": "4.3.2.1" }, { "name": "LocalFqdnName", "type": "string", "required": false, "description": "本端标识，当LocalIdentity选为FQDN时，LocalFqdnName必填", "example": "LocalName" }, { "name": "RemoteFqdnName", "type": "string", "required": false, "description": "对端标识，当remoteIdentity选为FQDN时，RemoteFqdnName必填", "example": "RemoteName" }, { "name": "DhGroupName", "type": "string", "required": false, "description": "DH group，指定IKE交换密钥时使用的DH组，可选值：'GROUP1', 'GROUP2', 'GROUP5', 'GROUP14', 'GROUP24'，默认是GROUP1。", "example": "GROUP1" }, { "name": "IKESaLifetimeSeconds", "type": "integer", "required": false, "description": "IKE SA Lifetime，单位：秒，设置IKE SA的生存周期，取值范围：60-604800", "example": "60" }, { "name": "IKEVersion", "type": "string", "required": false, "description": "IKE版本", "example": "IKEV1" } ] }, { "name": "IPSECOptionsSpecification", "type": "object", "required": false, "description": "IPSec配置，腾讯云提供IPSec安全会话设置", "example": "{'IPSECSaLifetimeSeconds': 7200}", "children": [ { "name": "EncryptAlgorithm", "type": "string", "required": false, "description": "加密算法，可选值：'3DES-CBC', 'AES-CBC-128', 'AES-CBC-192', 'AES-CBC-256', 'DES-CBC', 'SM4', 'NULL'， 默认为AES-CBC-128", "example": "AES-CBC-128" }, { "name": "IPSECSaLifetimeSeconds", "type": "integer", "required": false, "description": "IPsec SA lifetime(s)：单位秒，取值范围：180-604800", "example": "180" }, { "name": "PfsDhGroup", "type": "string", "required": false, "description": "PFS：可选值：'NULL', 'DH-GROUP1', 'DH-GROUP2', 'DH-GROUP5', 'DH-GROUP14', 'DH-GROUP24'，默认为NULL", "example": "NULL" }, { "name": "IPSECSaLifetimeTraffic", "type": "integer", "required": false, "description": "IPsec SA lifetime(KB)：单位KB，取值范围：2560-604800", "example": "2560" }, { "name": "IntegrityAlgorithm", "type": "string", "required": false, "description": "认证算法：可选值：'MD5', 'SHA1'，'SHA-256' 默认为", "example": "SHA1" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]", "example": "[{\"Key\": \"name\", \"Value\": \"123\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] }, { "name": "EnableHealthCheck", "type": "boolean", "required": false, "description": "是否支持隧道内健康检查，默认为False。", "example": "True" }, { "name": "HealthCheckLocalIp", "type": "string", "required": false, "description": "健康检查本端地址，默认值为随机在169.254.128.0/17分配一个IP。", "example": "169.254.128.1" }, { "name": "HealthCheckRemoteIp", "type": "string", "required": false, "description": "健康检查对端地址，默认值为随机在169.254.128.0/17分配一个IP。", "example": "169.254.128.2" }, { "name": "RouteType", "type": "string", "required": false, "description": "通道类型, 例如:[\"STATIC\", \"StaticRoute\", \"Policy\"]", "example": "STATIC" }, { "name": "NegotiationType", "type": "string", "required": false, "description": "协商类型，默认为active（主动协商）。可选值：active（主动协商），passive（被动协商），flowTrigger（流量协商）", "example": "active" }, { "name": "DpdEnable", "type": "integer", "required": false, "description": "DPD探测开关。默认为0，表示关闭DPD探测。可选值：0（关闭），1（开启）", "example": "1" }, { "name": "DpdTimeout", "type": "string", "required": false, "description": "DPD超时时间。即探测确认对端不存在需要的时间。dpdEnable为1（开启）时有效。默认30，单位为秒", "example": "30" }, { "name": "DpdAction", "type": "string", "required": false, "description": "DPD超时后的动作。默认为clear。dpdEnable为1（开启）时有效。可取值为clear（断开）和restart（重试）", "example": "clear" }, { "name": "Route", "type": "object", "required": false, "description": "创建通道路由信息。", "example": "{ 'DestinationCidrBlock': '10.0.0.0/32', 'Priority': 1 }", "children": [ { "name": "DestinationCidrBlock", "type": "string", "required": true, "description": "目的端IDC网段", "example": "11.0.0.0/16" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级；可选值0，100。", "example": "0" } ] }, { "name": "BgpConfig", "type": "object", "required": false, "description": "BGP配置。", "example": "{'TunnelCidr': '169.254.128.0/30', 'LocalBgpIp': '169.254.128.1', 'RemoteBgpIp': '169.254.128.2'}", "children": [ { "name": "TunnelCidr", "type": "string", "required": true, "description": "BGP隧道网段。", "example": "169.254.128.0/30" }, { "name": "LocalBgpIp", "type": "string", "required": true, "description": "云端BGP地址。必须从BGP隧道网段内分配。", "example": "169.254.128.1" }, { "name": "RemoteBgpIp", "type": "string", "required": true, "description": "用户端BGP地址。必须从BGP隧道网段内分配。", "example": "169.254.128.2" } ] }, { "name": "HealthCheckConfig", "type": "object", "required": false, "description": "健康检查NQA配置。", "example": "{'ProbeType': '123', 'ProbeInterval': 60, 'ProbeThreshold': 3, 'ProbeTimeout': 30}", "children": [ { "name": "ProbeType", "type": "string", "required": false, "description": "探测模式，默认值NQA，不可修改。", "example": "NQA" }, { "name": "ProbeInterval", "type": "integer", "required": false, "description": "探测间隔，腾讯云两次健康检查间隔时间，范围【1000-5000】，单位ms。", "example": "5000" }, { "name": "ProbeThreshold", "type": "integer", "required": false, "description": "探测次数，连续N次健康检查失败后执行路由切换，范围【3-8】，单位次。", "example": "3" }, { "name": "ProbeTimeout", "type": "integer", "required": false, "description": "探测超时时间，范围【10-5000】，单位ms。", "example": "150" } ] } ], "required": [ "VpnGatewayId", "CustomerGatewayId", "VpnConnectionName", "PreShareKey" ] }, { "name": "CreateVpnGateway", "description": "本接口（CreateVpnGateway）用于创建VPN网关。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC实例ID。可通过[DescribeVpcs](https://cloud.tencent.com/document/product/215/15778)接口返回值中的VpcId获取。", "example": "vpc-ngenl4az" }, { "name": "VpnGatewayName", "type": "string", "required": true, "description": "VPN网关名称，最大长度不能超过60个字节。", "example": "TEST_POSTPAID_VPNGW" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": true, "description": "公网带宽设置。可选带宽规格：5, 10, 20, 50, 100, 200, 500, 1000, 3000；单位：Mbps。", "example": "5" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "VPN网关计费模式，PREPAID：表示预付费，即包年包月，POSTPAID_BY_HOUR：表示后付费，即按量计费。默认：POSTPAID_BY_HOUR，如果指定预付费模式，参数InstanceChargePrepaid必填。", "example": "POSTPAID_BY_HOUR" }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费， NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费。默认：NOTIFY_AND_AUTO_RENEW", "example": "NOTIFY_AND_AUTO_RENEW" } ] }, { "name": "Zone", "type": "string", "required": false, "description": "可用区，如：ap-guangzhou-2。", "example": "ap-guangzhou" }, { "name": "Type", "type": "string", "required": false, "description": "VPN网关类型，默认为IPSEC。值“IPSEC”为VPC型IPSEC VPN网关，值“SSL”为VPC型SSL VPN网关，值“CCN”为云联网型IPSEC VPN网关，值“SSL_CCN”为云联网型SSL VPN网关。", "example": "CCN" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表，例如：[{\"Key\": \"city\", \"Value\": \"shanghai\"}]。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] }, { "name": "CdcId", "type": "string", "required": false, "description": "CDC实例ID。", "example": "cluster-gbo27yc4" }, { "name": "MaxConnection", "type": "integer", "required": false, "description": "SSL VPN连接数设置，可选规格：5, 10, 20, 50, 100, 200, 500, 1000；单位：个。仅 SSL / SSL_CCN 类型需要选这个参数。", "example": "5" }, { "name": "BgpAsn", "type": "integer", "required": false, "description": "BGP ASN。", "example": "2" } ], "required": [ "VpcId", "VpnGatewayName", "InternetMaxBandwidthOut" ] }, { "name": "CreateVpnGatewayRoutes", "description": "创建路由型VPN网关的目的路由", "status": "online", "parameters": [ { "name": "VpnGatewayId", "type": "string", "required": true, "description": "VPN网关的ID", "example": "vpn-ngenl4az" }, { "name": "Routes", "type": "array", "required": true, "description": "VPN网关目的路由列表", "example": "无", "item_type": "object", "children": [ { "name": "DestinationCidrBlock", "type": "string", "required": true, "description": "目的端IDC网段。", "example": "10.0.0.0/16" }, { "name": "InstanceType", "type": "string", "required": true, "description": "下一跳类型（关联实例类型）可选值：\"VPNCONN\"（VPN通道）， \"CCN\"（CCN实例）。", "example": "VPNCONN" }, { "name": "InstanceId", "type": "string", "required": true, "description": "下一跳实例ID。", "example": "vpc-awd131ca" }, { "name": "Priority", "type": "integer", "required": true, "description": "优先级，可选值：0，100。", "example": "0" }, { "name": "Status", "type": "string", "required": true, "description": "启用状态，可选值：\"ENABLE\"（启用），\"DISABLE\" (禁用)。", "example": "ENABLE" }, { "name": "RouteId", "type": "string", "required": false, "description": "路由条目ID。", "example": "vpnr-u2c2cfz8" }, { "name": "Type", "type": "string", "required": false, "description": "路由类型，可选值：\"VPC\"（VPC路由），\"CCN\"（云联网传播路由），\"Static\"（静态路由），\"BGP\"（BGP路由）。", "example": "VPC" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间。", "example": "2023-10-09 18:00:00" }, { "name": "UpdateTime", "type": "string", "required": false, "description": "更新时间。", "example": "2023-10-09 18:00:00" }, { "name": "Description", "type": "string", "required": false, "description": "路由备注", "example": "route-1" } ] } ], "required": [ "VpnGatewayId", "Routes" ] }, { "name": "CreateVpnGatewaySslClient", "description": "创建SSL-VPN-CLIENT", "status": "online", "parameters": [ { "name": "SslVpnServerId", "type": "string", "required": true, "description": "SSL-VPN-SERVER 实例ID。", "example": "vpns-5au854w1" }, { "name": "SslVpnClientName", "type": "string", "required": false, "description": "SSL-VPN-CLIENT实例Name。不可和SslVpnClientNames同时使用。", "example": "client-name" }, { "name": "SslVpnClientNames", "type": "array", "required": false, "description": "SSL-VPN-CLIENT实例Name数字。批量创建时使用。不可和SslVpnClientName同时使用。", "example": "[\"client-name-01\", \"client-name-02\"]", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表", "example": "[{\"Key\": \"name\", \"Value\": \"123\"}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] } ], "required": [ "SslVpnServerId" ] }, { "name": "CreateVpnGatewaySslServer", "description": "本接口（CreateVpnGatewaySslServer）用于创建SSL-VPN Server端。", "status": "online", "parameters": [ { "name": "VpnGatewayId", "type": "string", "required": true, "description": "VPN网关实例ID。", "example": "vpn-12345678" }, { "name": "SslVpnServerName", "type": "string", "required": true, "description": "SSL-VPN-SERVER 实例名称，长度不超过60个字节。", "example": "name" }, { "name": "RemoteAddress", "type": "string", "required": true, "description": "客户端地址网段。", "example": "172.16.0.0/16" }, { "name": "LocalAddress", "type": "array", "required": false, "description": "云端地址（CIDR）列表。", "example": "[\"10.0.0.0/16\"]", "item_type": "string" }, { "name": "SslVpnProtocol", "type": "string", "required": false, "description": "SSL VPN服务端监听协议。当前仅支持 UDP，默认UDP。", "example": "UDP" }, { "name": "SslVpnPort", "type": "integer", "required": false, "description": "SSL VPN服务端监听协议端口，默认1194。", "example": "1194" }, { "name": "IntegrityAlgorithm", "type": "string", "required": false, "description": "认证算法。可选 'SHA1'，默认SHA1。", "example": "SHA1" }, { "name": "EncryptAlgorithm", "type": "string", "required": false, "description": "加密算法。可选 'AES-128-CBC','AES-192-CBC', 'AES-256-CBC', 默认AES-128-CBC。", "example": "AES-128-CBC" }, { "name": "Compress", "type": "boolean", "required": false, "description": "是否支持压缩。当前不支持压缩，默认False。", "example": "false" }, { "name": "SsoEnabled", "type": "boolean", "required": false, "description": "是否开启SSO认证。默认为False。该功能当前需要申请开白使用。", "example": "false" }, { "name": "AccessPolicyEnabled", "type": "boolean", "required": false, "description": "是否开启策略访问控制。默认为False", "example": "false" }, { "name": "SamlData", "type": "string", "required": false, "description": "SAML-DATA，开启SSO时传。", "example": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGl" }, { "name": "Tags", "type": "array", "required": false, "description": "指定绑定的标签列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签键", "example": "tag-key" }, { "name": "Value", "type": "string", "required": false, "description": "标签值", "example": "tag-value" } ] }, { "name": "DnsServers", "type": "object", "required": false, "description": "DNS Server 地址", "example": "无", "children": [ { "name": "PrimaryDns", "type": "string", "required": false, "description": "主DNS配置", "example": "15.51.5.16" }, { "name": "SecondaryDns", "type": "string", "required": false, "description": "备DNS配置", "example": "15.51.67.1" } ] } ], "required": [ "VpnGatewayId", "SslVpnServerName", "RemoteAddress" ] }, { "name": "DeleteAddressTemplate", "description": "本接口（DeleteAddressTemplate）用于删除IP地址模板。 \u003e?本接口为异步接口，可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果，待任务执行成功后再进行其他操作。 \u003e", "status": "online", "parameters": [ { "name": "AddressTemplateId", "type": "string", "required": true, "description": "IP地址模板实例ID，例如：ipm-09o5m8kc。", "example": "ipm-09o5m8kc" } ], "required": [ "AddressTemplateId" ] }, { "name": "DeleteAddressTemplateGroup", "description": "本接口（DeleteAddressTemplateGroup）用于删除IP地址模板集合。 \u003e?本接口为异步接口，可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果，待任务执行成功后再进行其他操作。 \u003e", "status": "online", "parameters": [ { "name": "AddressTemplateGroupId", "type": "string", "required": true, "description": "IP地址模板集合实例ID，例如：ipmg-90cex8mq。", "example": "ipmg-90cex8mq" } ], "required": [ "AddressTemplateGroupId" ] }, { "name": "DeleteAssistantCidr", "description": "本接口（DeleteAssistantCidr）用于删除辅助CIDR。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "`VPC`实例`ID`。形如：`vpc-6v2ht8q5`。", "example": "vpc-12345678" }, { "name": "CidrBlocks", "type": "array", "required": true, "description": "CIDR数组，格式如[\"10.0.0.0/16\", \"172.16.0.0/16\"]。", "example": "[\"172.16.0.0\\/24\\n\"]", "item_type": "string" } ], "required": [ "VpcId", "CidrBlocks" ] }, { "name": "DeleteBandwidthPackage", "description": "接口支持删除共享带宽包，包括[设备带宽包](https://cloud.tencent.com/document/product/684/15245#bwptype)和[IP带宽包](https://cloud.tencent.com/document/product/684/15245#bwptype)", "status": "online", "parameters": [ { "name": "BandwidthPackageId", "type": "string", "required": true, "description": "待删除带宽包唯一ID，可以使用[DescribeBandwidthPackages](https://cloud.tencent.com/document/product/215/19209)接口查询BandwidthPackageId。", "example": "bwp-cs7j6pd0" } ], "required": [ "BandwidthPackageId" ] }, { "name": "DeleteCcn", "description": "本接口（DeleteCcn）用于删除云联网。 * 删除后，云联网关联的所有实例间路由将被删除，网络将会中断，请务必确认 * 删除云联网是不可逆的操作，请谨慎处理。", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "CCN实例ID。形如：ccn-f49l6u0z。", "example": "ccn-8j0phqix" } ], "required": [ "CcnId" ] }, { "name": "DeleteCcnPolicyBasedRoutingNextHop", "description": "删除云联网策略路由下一跳", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "云联网ID", "example": "ccn-7bw2xi31" }, { "name": "PolicyBasedRoutingNextHopIds", "type": "array", "required": true, "description": "策略路由下一跳ID", "example": "pbrnh-bbjdqarl", "item_type": "string" } ], "required": [ "CcnId", "PolicyBasedRoutingNextHopIds" ] }, { "name": "DeleteCcnPolicyBasedRoutingRule", "description": "删除云联网策略路由匹配规则", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "云联网ID", "example": "ccn-7bw2xi31" }, { "name": "PolicyBasedRoutingRuleIds", "type": "array", "required": true, "description": "策略路由匹配规则ID", "example": "pbrrule-n6anb2js", "item_type": "string" } ], "required": [ "CcnId", "PolicyBasedRoutingRuleIds" ] }, { "name": "DeleteCcnRouteTables", "description": "本接口（DeleteCcnRouteTables）用于删除云联网路由表。", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "array", "required": true, "description": "需要删除的路由表列表。", "example": "rtb-xxxxxxxx", "item_type": "string" } ], "required": [ "RouteTableId" ] }, { "name": "DeleteCdcLDCXList", "description": "删除 IDC通道", "status": "online", "parameters": [], "required": [] }, { "name": "DeleteCdcNetPlanes", "description": "删除虚拟连接", "status": "online", "parameters": [], "required": [] }, { "name": "DeleteCustomerGateway", "description": "本接口（DeleteCustomerGateway）用于删除对端网关。", "status": "online", "parameters": [ { "name": "CustomerGatewayId", "type": "string", "required": true, "description": "对端网关ID，例如：cgw-2wqq41m9，可通过[DescribeCustomerGateways](https://cloud.tencent.com/document/api/215/17516)接口查询对端网关。", "example": "cgw-2wqq41m9" } ], "required": [ "CustomerGatewayId" ] }, { "name": "DeleteDhcpIp", "description": "本接口（DeleteDhcpIp）用于删除DhcpIp。 \u003e?本接口为异步接口，可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果，待任务执行成功后再进行其他操作。 \u003e", "status": "online", "parameters": [ { "name": "DhcpIpId", "type": "string", "required": true, "description": "`DhcpIp`的`ID`，是`DhcpIp`的唯一标识。", "example": "dhcpip-12345678" } ], "required": [ "DhcpIpId" ] }, { "name": "DeleteDirectConnectGateway", "description": "本接口（DeleteDirectConnectGateway）用于删除专线网关。 如果是 NAT 网关，删除专线网关后，NAT 规则以及 ACL 策略都被清理了。 删除专线网关后，系统会删除路由表中跟该专线网关相关的路由策略。 本接口是异步完成，如需查询异步任务执行结果，请使用本接口返回的`RequestId`轮询`QueryTask`接口", "status": "online", "parameters": [ { "name": "DirectConnectGatewayId", "type": "string", "required": true, "description": "专线网关唯一`ID`，形如：`dcg-9o233uri`。", "example": "dcg-9o233uri" } ], "required": [ "DirectConnectGatewayId" ] }, { "name": "DeleteDirectConnectGatewayCcnRoutes", "description": "本接口（DeleteDirectConnectGatewayCcnRoutes）用于删除专线网关的云联网路由（IDC网段）", "status": "online", "parameters": [ { "name": "DirectConnectGatewayId", "type": "string", "required": true, "description": "专线网关ID，形如：dcg-prpqlmg1", "example": "dcg-prpqlmg1" }, { "name": "RouteIds", "type": "array", "required": true, "description": "路由ID。形如：ccnr-f49l6u0z。", "example": "[\"ccnr-bvipc87w\\r\\n\"]", "item_type": "string" }, { "name": "AddressType", "type": "string", "required": false, "description": "地址类型，支持：IPv4、IPv6。默认IPv4。", "example": "IPv4" } ], "required": [ "DirectConnectGatewayId", "RouteIds" ] }, { "name": "DeleteFlowLog", "description": "本接口（DeleteFlowLog）用于删除流日志。", "status": "online", "parameters": [ { "name": "FlowLogId", "type": "string", "required": true, "description": "流日志唯一ID。可通过[CreateFlowLog](https://cloud.tencent.com/document/product/215/35015)接口创建；可通过[DescribeFlowLogs](https://cloud.tencent.com/document/product/215/35012)接口获取。", "example": "fl-ng9pgduh" }, { "name": "VpcId", "type": "string", "required": false, "description": "私用网络唯一ID。删除云联网流日志时，可不填，其他流日志类型必填。可通过[DescribeFlowLogs](https://cloud.tencent.com/document/product/215/35012)接口获取流日志对应的私有网络唯一ID。也可通过[DescribeVpcs](https://cloud.tencent.com/document/product/215/15778)接口获取当前账户的私有网络唯一ID。", "example": "vpc-ec37wwkm" } ], "required": [ "FlowLogId" ] }, { "name": "DeleteGlobalRoutes", "description": "删除全局路由。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC唯一Id。", "example": "vpc-mcqaoy0f" }, { "name": "GlobalRouteIds", "type": "array", "required": true, "description": "全局路由实例唯一Id列表。", "example": "[\"gr-bmenrwu2\"]", "item_type": "string" } ], "required": [ "VpcId", "GlobalRouteIds" ] }, { "name": "DeleteHaVip", "description": "本接口（DeleteHaVip）用于删除高可用虚拟IP（HAVIP）。 本接口是异步完成，如需查询异步任务执行结果，请使用本接口返回的`RequestId`轮询`DescribeVpcTaskResult`接口。", "status": "online", "parameters": [ { "name": "HaVipId", "type": "string", "required": true, "description": "`HAVIP`唯一`ID`，形如：`havip-9o233uri`。", "example": "havip-9o233uri" } ], "required": [ "HaVipId" ] }, { "name": "DeleteHighPriorityRouteTables", "description": "删除高优路由表", "status": "online", "parameters": [ { "name": "HighPriorityRouteTableIds", "type": "array", "required": false, "description": "高优路由表表唯一ID 列表。", "example": "[\"hprtb-18mot1fm\"]", "item_type": "string" } ], "required": [] }, { "name": "DeleteHighPriorityRoutes", "description": "删除高优路由表的路由条目。", "status": "online", "parameters": [ { "name": "HighPriorityRouteTableId", "type": "string", "required": true, "description": "高优路由表唯一 ID。", "example": "hprtb-18mot1fm" }, { "name": "HighPriorityRouteIds", "type": "array", "required": true, "description": "高优路由表条目唯一 ID 列表。", "example": "[\"hprti-p1ymd0ak\"]", "item_type": "string" } ], "required": [ "HighPriorityRouteTableId", "HighPriorityRouteIds" ] }, { "name": "DeleteIp6Translators", "description": "1. 该接口用于释放IPV6转换实例，支持批量。 2. 如果IPV6转换实例建立有转换规则，会一并删除。", "status": "online", "parameters": [ { "name": "Ip6TranslatorIds", "type": "array", "required": true, "description": "待释放的IPV6转换实例的唯一ID，形如‘ip6-xxxxxxxx’", "example": "ip6-12345678", "item_type": "string" } ], "required": [ "Ip6TranslatorIds" ] }, { "name": "DeleteLocalGateway", "description": "本接口（DeleteLocalGateway）用于删除CDC的本地网关。", "status": "online", "parameters": [ { "name": "LocalGatewayId", "type": "string", "required": true, "description": "本地网关实例ID。", "example": "lgw-1234rfgt" }, { "name": "CdcId", "type": "string", "required": true, "description": "CDC实例ID。", "example": "cluster-gbo27yc4" }, { "name": "VpcId", "type": "string", "required": false, "description": "VPC实例ID。", "example": "vpc-m0c2kcun" } ], "required": [ "LocalGatewayId", "CdcId" ] }, { "name": "DeleteNatGateway", "description": "本接口（DeleteNatGateway）用于删除NAT网关。 删除 NAT 网关后，系统会自动删除路由表中包含此 NAT 网关的路由项，同时也会解绑弹性公网IP（EIP）。", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "NAT网关的ID，形如：`nat-df45454`。", "example": "nat-ig8xpno8" }, { "name": "IgnoreOperationRisk", "type": "boolean", "required": false, "description": "忽略操作风险", "example": "false" } ], "required": [ "NatGatewayId" ] }, { "name": "DeleteNatGatewayDestinationIpPortTranslationNatRule", "description": "本接口（DeleteNatGatewayDestinationIpPortTranslationNatRule）用于删除NAT网关端口转发规则。", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "NAT网关的ID，形如：`nat-df45454`。", "example": "nat-3isn9hr0" }, { "name": "DestinationIpPortTranslationNatRules", "type": "array", "required": true, "description": "NAT网关的端口转换规则。", "example": "无", "item_type": "object", "children": [ { "name": "IpProtocol", "type": "string", "required": true, "description": "网络协议，可选值：`TCP`、`UDP`。", "example": "TCP" }, { "name": "PublicIpAddress", "type": "string", "required": true, "description": "弹性IP。", "example": "114.182.81.73" }, { "name": "PublicPort", "type": "integer", "required": true, "description": "公网端口。", "example": "80" }, { "name": "PrivateIpAddress", "type": "string", "required": true, "description": "内网地址。", "example": "192.168.4.43" }, { "name": "PrivatePort", "type": "integer", "required": true, "description": "内网端口。", "example": "80" }, { "name": "Description", "type": "string", "required": false, "description": "NAT网关转发规则描述。", "example": "webservice" } ] } ], "required": [ "NatGatewayId", "DestinationIpPortTranslationNatRules" ] }, { "name": "DeleteNatGatewaySourceIpTranslationNatRule", "description": "本接口（DeleteNatGatewaySourceIpTranslationNatRule）用于删除NAT网关端口SNAT转发规则。", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "NAT网关的ID，形如：`nat-df45454`。", "example": "nat-3isn9hr0" }, { "name": "NatGatewaySnatIds", "type": "array", "required": true, "description": "NAT网关的SNAT ID列表，形如：`snat-df43254`。", "example": "[\"snat-3ixd0hr0\"]", "item_type": "string" } ], "required": [ "NatGatewayId", "NatGatewaySnatIds" ] }, { "name": "DeleteNetDetect", "description": "本接口（DeleteNetDetect）用于删除网络探测实例。", "status": "online", "parameters": [ { "name": "NetDetectId", "type": "string", "required": true, "description": "网络探测实例`ID`。形如：`netd-12345678`。", "example": "netd-12345678" } ], "required": [ "NetDetectId" ] }, { "name": "DeleteNetworkAcl", "description": "本接口（DeleteNetworkAcl）用于删除网络ACL。", "status": "online", "parameters": [ { "name": "NetworkAclId", "type": "string", "required": true, "description": "网络ACL实例ID。例如：acl-12345678。", "example": "acl-12345678" } ], "required": [ "NetworkAclId" ] }, { "name": "DeleteNetworkAclEntries", "description": "本接口（DeleteNetworkAclEntries）用于删除三元组网络ACL的入站规则和出站规则。在NetworkAclEntrySet参数中： * 删除IPv4规则，需要传入NetworkAclIpv4EntryId。 * 删除IPv6规则，需要传入NetworkAclIpv6EntryId。", "status": "online", "parameters": [ { "name": "NetworkAclId", "type": "string", "required": true, "description": "三元组网络ACL实例ID。例如：acl-12345678。", "example": "acl-12345678" }, { "name": "NetworkAclEntrySet", "type": "object", "required": false, "description": "三元组网络ACL规则集。", "example": "无", "children": [ { "name": "Ingress", "type": "array", "required": false, "description": "入站规则。", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP, ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。使用-指定端口范围，如：10-20。", "example": "8080" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)。增量创建ACL规则时，CidrBlock和Ipv6CidrBlock至少提供一个。", "example": "10.0.0.0/24" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。", "example": "3402:4e00:20:1200::/56" }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "Description", "type": "string", "required": false, "description": "规则描述，最大长度100。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间。", "example": "2018-04-25 10:26:26" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级，从1开始。", "example": "1" }, { "name": "NetworkAclIpv4EntryId", "type": "string", "required": false, "description": "IPv4网络ACL条目唯一ID。当修改ACL条目时，NetworkAclIpv4EntryId和NetworkAclIpv6EntryID至少提供一个。", "example": "acli43-0pngbwph" }, { "name": "NetworkAclIpv6EntryId", "type": "string", "required": false, "description": "IPv6网络ACL条目唯一ID。当修改ACL条目时，NetworkAclIpv4EntryId和NetworkAclIpv6EntryId至少提供一个。", "example": "acli46-0pngbwph" } ] }, { "name": "Egress", "type": "array", "required": false, "description": "出站规则。", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP, ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。使用-指定端口范围，如：10-20。", "example": "8080" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)。增量创建ACL规则时，CidrBlock和Ipv6CidrBlock至少提供一个。", "example": "10.0.0.0/24" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。", "example": "3402:4e00:20:1200::/56" }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "Description", "type": "string", "required": false, "description": "规则描述，最大长度100。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间。", "example": "2018-04-25 10:26:26" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级，从1开始。", "example": "1" }, { "name": "NetworkAclIpv4EntryId", "type": "string", "required": false, "description": "IPv4网络ACL条目唯一ID。当修改ACL条目时，NetworkAclIpv4EntryId和NetworkAclIpv6EntryID至少提供一个。", "example": "acli43-0pngbwph" }, { "name": "NetworkAclIpv6EntryId", "type": "string", "required": false, "description": "IPv6网络ACL条目唯一ID。当修改ACL条目时，NetworkAclIpv4EntryId和NetworkAclIpv6EntryId至少提供一个。", "example": "acli46-0pngbwph" } ] } ] } ], "required": [ "NetworkAclId" ] }, { "name": "DeleteNetworkAclQuintupleEntries", "description": "本接口（DeleteNetworkAclQuintupleEntries）用于删除网络ACL五元组指定的入站规则和出站规则（但不是全量删除该ACL下的所有条目）。在NetworkAclQuintupleEntrySet参数中：NetworkAclQuintupleEntry需要提供NetworkAclQuintupleEntryId。", "status": "online", "parameters": [ { "name": "NetworkAclId", "type": "string", "required": true, "description": "网络ACL实例ID。例如：acl-12345678。", "example": "acl-12345678" }, { "name": "NetworkAclQuintupleSet", "type": "object", "required": true, "description": "网络五元组ACL规则集。", "example": "无", "children": [ { "name": "Ingress", "type": "array", "required": false, "description": "网络ACL五元组入站规则。", "example": "[{ 'SourcePort':'446', 'SourceCidr': '10.0.0.2/24', 'Protocol': ", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP, ALL。", "example": "UDP" }, { "name": "Description", "type": "string", "required": false, "description": "描述。", "example": "demo" }, { "name": "SourcePort", "type": "string", "required": false, "description": "源端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。", "example": "446" }, { "name": "SourceCidr", "type": "string", "required": false, "description": "源CIDR。", "example": "192.168.0.0/24" }, { "name": "DestinationPort", "type": "string", "required": false, "description": "目的端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。", "example": "446" }, { "name": "DestinationCidr", "type": "string", "required": false, "description": "目的CIDR。", "example": "192.168.0.0/24" }, { "name": "Action", "type": "string", "required": false, "description": "动作，ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "NetworkAclQuintupleEntryId", "type": "string", "required": false, "description": "网络ACL条目唯一ID。", "example": "acli45-ahnu4rv5" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级，从1开始。", "example": "1" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间，用于DescribeNetworkAclQuintupleEntries的出参。", "example": "2021-03-02 14:41:15" }, { "name": "NetworkAclDirection", "type": "string", "required": false, "description": "方向，INGRESS或EGRESS，用于DescribeNetworkAclQuintupleEntries的出参。", "example": "INGRESS" }, { "name": "SourceIPv6Cidr", "type": "string", "required": false, "description": "IPv6源CIDR。", "example": "12::1/128" }, { "name": "DestinationIPv6Cidr", "type": "string", "required": false, "description": "IPv6目的CIDR。", "example": "13::1/128" } ] }, { "name": "Egress", "type": "array", "required": false, "description": "网络ACL五元组出站规则", "example": "[{ 'SourcePort':'446', 'SourceCidr': '10.0.0.2/24', 'Protocol': ", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP, ALL。", "example": "UDP" }, { "name": "Description", "type": "string", "required": false, "description": "描述。", "example": "demo" }, { "name": "SourcePort", "type": "string", "required": false, "description": "源端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。", "example": "446" }, { "name": "SourceCidr", "type": "string", "required": false, "description": "源CIDR。", "example": "192.168.0.0/24" }, { "name": "DestinationPort", "type": "string", "required": false, "description": "目的端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。", "example": "446" }, { "name": "DestinationCidr", "type": "string", "required": false, "description": "目的CIDR。", "example": "192.168.0.0/24" }, { "name": "Action", "type": "string", "required": false, "description": "动作，ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "NetworkAclQuintupleEntryId", "type": "string", "required": false, "description": "网络ACL条目唯一ID。", "example": "acli45-ahnu4rv5" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级，从1开始。", "example": "1" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间，用于DescribeNetworkAclQuintupleEntries的出参。", "example": "2021-03-02 14:41:15" }, { "name": "NetworkAclDirection", "type": "string", "required": false, "description": "方向，INGRESS或EGRESS，用于DescribeNetworkAclQuintupleEntries的出参。", "example": "INGRESS" }, { "name": "SourceIPv6Cidr", "type": "string", "required": false, "description": "IPv6源CIDR。", "example": "12::1/128" }, { "name": "DestinationIPv6Cidr", "type": "string", "required": false, "description": "IPv6目的CIDR。", "example": "13::1/128" } ] } ] } ], "required": [ "NetworkAclId", "NetworkAclQuintupleSet" ] }, { "name": "DeleteNetworkInterface", "description": "本接口（DeleteNetworkInterface）用于删除弹性网卡。 * 弹性网卡上绑定了云服务器时，不能被删除。 * 删除指定弹性网卡，弹性网卡必须先和子机解绑才能删除。删除之后弹性网卡上所有内网IP都将被退还。 本接口是异步完成，如需查询异步任务执行结果，请使用本接口返回的`RequestId`轮询[DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口。", "status": "online", "parameters": [ { "name": "NetworkInterfaceId", "type": "string", "required": true, "description": "弹性网卡实例ID，例如：eni-m6dyj72l。可通过[DescribeNetworkInterfaces](https://cloud.tencent.com/document/product/215/15817)接口获取。", "example": "eni-m6dyj72l" } ], "required": [ "NetworkInterfaceId" ] }, { "name": "DeletePrivateNatGateway", "description": "本接口（DeletePrivateNatGateway）用于删除私网NAT网关。", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "私网网关唯一`ID`，形如\"intranat-xxxxxxxx\"。", "example": "intranat-0g3blj80" }, { "name": "IgnoreOperationRisk", "type": "boolean", "required": false, "description": "忽略操作风险", "example": "false" } ], "required": [ "NatGatewayId" ] }, { "name": "DeletePrivateNatGatewayDestinationIpPortTranslationNatRule", "description": "本接口（DeletePrivateNatGatewayDestinationIpPortTranslationNatRule）用于删除私网NAT网关目的端口转换规则", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "私网网关唯一`ID`，形如：`intranat-xxxxxxxx`。", "example": "intranat-0g3blj80" }, { "name": "LocalDestinationIpPortTranslationNatRules", "type": "array", "required": true, "description": "目的端口转换规则数组。", "example": "无", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议，包含TCP和UDP", "example": "TCP" }, { "name": "OriginalPort", "type": "integer", "required": true, "description": "映射前端口", "example": "80" }, { "name": "OriginalIp", "type": "string", "required": true, "description": "映射前IP", "example": "192.168.4.43" }, { "name": "TranslationPort", "type": "integer", "required": true, "description": "映射后端口", "example": "80" }, { "name": "TranslationIp", "type": "string", "required": true, "description": "映射后IP", "example": "10.254.4.43" }, { "name": "Description", "type": "string", "required": false, "description": "描述", "example": "webservice" } ] } ], "required": [ "NatGatewayId", "LocalDestinationIpPortTranslationNatRules" ] }, { "name": "DeletePrivateNatGatewayTranslationAclRule", "description": "本接口（DeletePrivateNatGatewayTranslationAclRule）用于删除私网NAT网关源端转换访问控制规则", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "私网网关唯一`ID`，形如：`intranat-xxxxxxxx`。", "example": "intranat-0g3blj80" }, { "name": "TranslationDirection", "type": "string", "required": true, "description": "转换规则目标，可选值LOCAL。", "example": "LOCAL" }, { "name": "TranslationType", "type": "string", "required": true, "description": "转换规则类型，可选值NETWORK_LAYER、TRANSPORT_LAYER。分别对应三层、四层。", "example": "NETWORK_LAYER" }, { "name": "TranslationIp", "type": "string", "required": true, "description": "映射后`IP`,当转换规则类型为四层时为`IP`池", "example": "10.0.13.20" }, { "name": "AclRuleIds", "type": "array", "required": true, "description": "访问控制规则对应`ID`", "example": "[1,5,26]", "item_type": "integer" }, { "name": "OriginalIp", "type": "string", "required": false, "description": "映射前`IP`,当转换规则类型为三层时有效", "example": "10.0.13.19" } ], "required": [ "NatGatewayId", "TranslationDirection", "TranslationType", "TranslationIp", "AclRuleIds" ] }, { "name": "DeletePrivateNatGatewayTranslationNatRule", "description": "本接口（DeletePrivateNatGatewayTranslationNatRule）用于删除私网NAT网关源端转换规则", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "私网网关唯一`ID`，形如：`intranat-xxxxxxxx`。", "example": "intranat-0g3blj80" }, { "name": "TranslationNatRules", "type": "array", "required": true, "description": "转换规则对象数组。", "example": "无", "item_type": "object", "children": [ { "name": "TranslationDirection", "type": "string", "required": true, "description": "转换规则目标，可选值\"LOCAL\",\"PEER\"。", "example": "\"LOCAL\"" }, { "name": "TranslationType", "type": "string", "required": true, "description": "转换规则类型，可选值\"NETWORK_LAYER\",\"TRANSPORT_LAYER\"。分别对应三层和四层。", "example": "\"NETWORK_LAYER\"" }, { "name": "TranslationIp", "type": "string", "required": true, "description": "映射后IP,当转换规则类型为四层时为`IP`池。", "example": "\"10.0.13.21\"" }, { "name": "Description", "type": "string", "required": true, "description": "转换规则描述。", "example": "my service" }, { "name": "OriginalIp", "type": "string", "required": false, "description": "映射前IP,当转换规则类型为三层时有效。", "example": "\"10.0.13.20\"" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间。", "example": "\"2022-09-29 15:58:00\"" }, { "name": "UpdateTime", "type": "string", "required": false, "description": "更新时间。", "example": "\"2022-09-29 15:58:00\"" } ] }, { "name": "CrossDomain", "type": "boolean", "required": false, "description": "跨域参数，当VPC为跨域时填写为True。", "example": "true" } ], "required": [ "NatGatewayId", "TranslationNatRules" ] }, { "name": "DeleteReserveIpAddresses", "description": "删除内网保留IP", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC唯一 ID。", "example": "vpc-mcqaoy0f" }, { "name": "ReserveIpIds", "type": "array", "required": true, "description": "内网保留IP地址列表。", "example": "[\"rsvip-7pg1y5xy\"]", "item_type": "string" } ], "required": [ "VpcId", "ReserveIpIds" ] }, { "name": "DeleteRoutePolicy", "description": "本接口（DeleteRoutePolicy）用于删除路由接收策略和条目。", "status": "online", "parameters": [ { "name": "RoutePolicyId", "type": "string", "required": true, "description": "路由接收策略唯一ID。", "example": "rrp-pguby7ma" } ], "required": [ "RoutePolicyId" ] }, { "name": "DeleteRoutePolicyAssociations", "description": "本接口(DeleteRoutePolicyAssociations)用于删除路由接收策略绑定（路由接收策略对象和路由表的绑定关系）。", "status": "online", "parameters": [ { "name": "RoutePolicyAssociationSet", "type": "array", "required": true, "description": "路由策略绑定对象列表，删除路由策略绑定时，仅需使用RoutePolicyAssociation的RouteTableId字段和RoutePolicyId字段（不需要填写Priority字段）。", "example": "无", "item_type": "object", "children": [ { "name": "RouteTableId", "type": "string", "required": false, "description": "路由表唯一ID。", "example": "rtb-qk8eyn9g" }, { "name": "RoutePolicyId", "type": "string", "required": false, "description": "路由接收策略唯一ID。", "example": "rrp-r70ctaia" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级。", "example": "100" } ] } ], "required": [ "RoutePolicyAssociationSet" ] }, { "name": "DeleteRoutePolicyEntries", "description": "本接口(DeleteRoutePolicyEntries)用于删除路由接收策略条目。", "status": "online", "parameters": [ { "name": "RoutePolicyId", "type": "string", "required": true, "description": "路由接收策略实例ID。", "example": "rrp-q7ywkx3w" }, { "name": "RoutePolicyEntrySet", "type": "array", "required": false, "description": "路由接收策略条目列表，删除路由策略规则时，仅需使用RoutePolicyEntry的RoutePolicyEntryIdId字段。", "example": "无", "item_type": "object", "children": [ { "name": "RoutePolicyEntryId", "type": "string", "required": false, "description": "路由策略条目IPv4唯一ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "rrpi-hd7hsfhh" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "目标网段。 注意：此字段可能返回 null，表示取不到有效值。", "example": "13.0.0.0/16" }, { "name": "Description", "type": "string", "required": false, "description": "路由策略规则描述。 注意：此字段可能返回 null，表示取不到有效值。", "example": "demo" }, { "name": "RouteType", "type": "string", "required": false, "description": "路由类型。 USER：用户自定义类型。 NETD：网络探测下发的路由。 CCN：云联网路由。 注意：此字段可能返回 null，表示取不到有效值。", "example": "CCN" }, { "name": "GatewayType", "type": "string", "required": false, "description": "下一跳类型。目前我们支持的类型有： CVM：公网网关类型的云服务器； VPN：VPN网关； DIRECTCONNECT：专线网关； PEERCONNECTION：对等连接； HAVIP：高可用虚拟IP； NAT：NAT网关; EIP：云服务器的公网IP； LOCAL_GATEWAY：本地网关; PVGW：PVGW网关。 注意：此字段可能返回 null，表示取不到有效值。", "example": "CVM" }, { "name": "GatewayId", "type": "string", "required": false, "description": "网关唯一ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "172.16.16.37" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级。数值越小，优先级越高。 注意：此字段可能返回 null，表示取不到有效值。", "example": "100" }, { "name": "Action", "type": "string", "required": false, "description": "动作。 DROP：丢弃。 DISABLE：接收且禁用。 ACCEPT：接收且启用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ACCEPT" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "创建时间。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2023-05-20 15:06:34" }, { "name": "Region", "type": "string", "required": false, "description": "地域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-guangzhou" } ] } ], "required": [ "RoutePolicyId" ] }, { "name": "DeleteRouteTable", "description": "本接口（DeleteRouteTable）用于删除路由表。", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表实例ID，例如：rtb-azd4dt1c。", "example": "rtb-azd4dt1c" } ], "required": [ "RouteTableId" ] }, { "name": "DeleteRoutes", "description": "本接口(DeleteRoutes)用于对某个路由表批量删除路由策略（Route）。", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表实例ID。", "example": "rtb-h0fk8lfc" }, { "name": "Routes", "type": "array", "required": false, "description": "路由策略对象，删除路由策略时，仅需使用Route的RouteId字段。", "example": "[{\"RouteItemId\": \"rti-hj3he929\"}]", "item_type": "object", "children": [ { "name": "DestinationCidrBlock", "type": "string", "required": true, "description": "创建IPv4目的网段，取值不能在私有网络网段内，例如：112.20.51.0/24。", "example": "10.0.0.0/24" }, { "name": "GatewayType", "type": "string", "required": true, "description": "下一跳类型，目前我们支持的类型有： CVM：公网网关类型的云服务器； VPN：VPN网关； DIRECTCONNECT：专线网关； PEERCONNECTION：对等连接； HAVIP：高可用虚拟IP； NAT：公网NAT网关; NORMAL_CVM：普通云服务器； EIP：云服务器的公网IP； LOCAL_GATEWAY：CDC本地网关； INTRANAT：私网NAT网关； USER_CCN：云联网（自定义路由）； GWLB_ENDPOINT：网关负载均衡终端节点。", "example": "CCN" }, { "name": "GatewayId", "type": "string", "required": true, "description": "下一跳地址，这里只需要指定不同下一跳类型的网关ID，系统会自动匹配到下一跳地址。 特殊说明： GatewayType为NORMAL_CVM时，GatewayId填写实例的内网IP。 GatewayType为EIP时，GatewayId填写0。", "example": "ccn-e187un9p" }, { "name": "RouteId", "type": "integer", "required": false, "description": "路由策略ID。IPv4路由策略ID是有意义的值，IPv6路由策略是无意义的值0。后续建议完全使用字符串唯一ID `RouteItemId`操作路由策略。 该字段在删除时必填，其他字段无需填写。", "example": "1289089" }, { "name": "RouteDescription", "type": "string", "required": false, "description": "路由策略描述。", "example": "demo" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否启用", "example": "true" }, { "name": "RouteType", "type": "string", "required": false, "description": "路由类型，目前我们支持的类型有： USER：用户路由； NETD：网络探测路由，创建网络探测实例时，系统默认下发，不可编辑与删除； CCN：云联网路由，系统默认下发，不可编辑与删除。 用户只能添加和操作 USER 类型的路由。", "example": "CCN" }, { "name": "RouteTableId", "type": "string", "required": false, "description": "路由表实例ID，例如：rtb-azd4dt1c。", "example": "rtb-azd4dt1c" }, { "name": "DestinationIpv6CidrBlock", "type": "string", "required": false, "description": "创建IPv6目的网段，取值不能在私有网络网段内，例如：2402:4e00:1000:810b::/64。", "example": "3402:4e00:20:1200::/56" }, { "name": "RouteItemId", "type": "string", "required": false, "description": "路由唯一策略ID。", "example": "rti-9bjer08h" }, { "name": "PublishedToVbc", "type": "boolean", "required": false, "description": "路由策略是否发布到云联网。该字段仅做出参使用，作为入参字段时此参数不生效。", "example": "true" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "路由策略创建时间", "example": "2021-03-02 14:41:15" }, { "name": "CdcId", "type": "string", "required": false, "description": "CDC 集群唯一 ID。", "example": "cluster-d8htgb6k" } ] } ], "required": [ "RouteTableId" ] }, { "name": "DeleteSecurityGroup", "description": "本接口（DeleteSecurityGroup）用于删除安全组（SecurityGroup）。 * 只有当前账号下的安全组允许被删除。 * 安全组实例ID如果在其他安全组的规则中被引用，则无法直接删除。这种情况下，需要先进行规则修改，再删除安全组。 * 删除的安全组无法再找回，请谨慎调用。", "status": "online", "parameters": [ { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组实例ID，例如sg-33ocnj9n，可通过DescribeSecurityGroups获取。", "example": "sg-33ocnj9n" } ], "required": [ "SecurityGroupId" ] }, { "name": "DeleteSecurityGroupPolicies", "description": "本接口（DeleteSecurityGroupPolicies）用于删除安全组规则（SecurityGroupPolicy）。 * SecurityGroupPolicySet.Version 用于指定要操作的安全组的版本。传入 Version 版本号若不等于当前安全组的最新版本，将返回失败；若不传 Version 则直接删除指定PolicyIndex的规则。", "status": "online", "parameters": [ { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组实例ID，例如sg-33ocnj9n，可通过DescribeSecurityGroups获取。", "example": "sg-ohuuioma" }, { "name": "SecurityGroupPolicySet", "type": "object", "required": true, "description": "安全组规则集合。一个请求中只能删除单个方向的一条或多条规则。支持指定索引（PolicyIndex） 匹配删除和安全组规则匹配删除两种方式，一个请求中只能使用一种匹配方式。 使用安全组规则匹配删除时，需要填写`Action`， `Protocol`， `CidrBlock`， `Port`参数。", "example": "无", "children": [ { "name": "Version", "type": "string", "required": false, "description": "安全组规则当前版本。用户每次更新安全规则版本会自动加1，防止更新的路由规则已过期，不填不考虑冲突。", "example": "10" }, { "name": "Egress", "type": "array", "required": false, "description": "出站规则。", "example": "[{\"PolicyIndex\": 0, \"Port\": \"443\", \"CidrBlock\": \"10.0.0.0/24\", \"Action\": \"ACCEPT\", \"ModifyTime\": \"2020-10-09 10:00:00\", \"PolicyDescription\": \"\", \"Protocol\": \"tcp\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号，值会随着安全组规则的变更动态变化。使用PolicyIndex时，请先调用`DescribeSecurityGroupPolicies`获取到规则的PolicyIndex，并且结合返回值中的Version一起使用处理规则。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP,ICMP,ICMPv6,ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。 说明：如果Protocol设置为ALL，则Port也需要设置为all。", "example": "22" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "ppm-8g7k5qfq", "children": [ { "name": "ServiceId", "type": "string", "required": false, "description": "协议端口ID，例如：ppm-f5n1f8da。", "example": "ppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": false, "description": "协议端口组ID，例如：ppmg-f5n1f8da。", "example": "ppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)，特殊说明：0.0.0.0/n 都会映射为0.0.0.0/0。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IP地址。", "example": "10.0.0.0/16" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IPv6地址。", "example": "::/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：sg-ohuuioma。", "example": "sg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者IP地址组ID。", "example": "ipm-p5sf61yj", "children": [ { "name": "AddressId", "type": "string", "required": false, "description": "IP地址ID，例如：ipm-2uw6ujo6。", "example": "ipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": false, "description": "IP地址组ID，例如：ipmg-2uw6ujo6。", "example": "ipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。作为入参时，当未传递该参数或值为空，且参数CidrBlock或Ipv6CidrBlock值为MY_PUBLIC_IP时，该参数的值将会被自动填充为Replaced-From-MY_PUBLIC_IP。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "安全组最近修改时间。", "example": "2021-03-02 14:41:15" }, { "name": "Priority", "type": "integer", "required": false, "description": "安全组规则优先级，值会随着安全组规则的变更动态变化。使用Priority时，请先调用`DescribeSecurityGroupPolicies`获取到规则的Priority，并且结合返回值中的Version一起使用处理规则。" } ] }, { "name": "Ingress", "type": "array", "required": false, "description": "入站规则。", "example": "[{\"PolicyIndex\": 0, \"Port\": \"443\", \"CidrBlock\": \"0.0.0.0/0\", \"Action\": \"ACCEPT\", \"ModifyTime\": \"2020-10-09 10:00:00\", \"PolicyDescription\": \"\", \"Protocol\": \"tcp\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号，值会随着安全组规则的变更动态变化。使用PolicyIndex时，请先调用`DescribeSecurityGroupPolicies`获取到规则的PolicyIndex，并且结合返回值中的Version一起使用处理规则。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP,ICMP,ICMPv6,ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。 说明：如果Protocol设置为ALL，则Port也需要设置为all。", "example": "22" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "ppm-8g7k5qfq", "children": [ { "name": "ServiceId", "type": "string", "required": false, "description": "协议端口ID，例如：ppm-f5n1f8da。", "example": "ppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": false, "description": "协议端口组ID，例如：ppmg-f5n1f8da。", "example": "ppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)，特殊说明：0.0.0.0/n 都会映射为0.0.0.0/0。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IP地址。", "example": "10.0.0.0/16" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IPv6地址。", "example": "::/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：sg-ohuuioma。", "example": "sg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者IP地址组ID。", "example": "ipm-p5sf61yj", "children": [ { "name": "AddressId", "type": "string", "required": false, "description": "IP地址ID，例如：ipm-2uw6ujo6。", "example": "ipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": false, "description": "IP地址组ID，例如：ipmg-2uw6ujo6。", "example": "ipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。作为入参时，当未传递该参数或值为空，且参数CidrBlock或Ipv6CidrBlock值为MY_PUBLIC_IP时，该参数的值将会被自动填充为Replaced-From-MY_PUBLIC_IP。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "安全组最近修改时间。", "example": "2021-03-02 14:41:15" }, { "name": "Priority", "type": "integer", "required": false, "description": "安全组规则优先级，值会随着安全组规则的变更动态变化。使用Priority时，请先调用`DescribeSecurityGroupPolicies`获取到规则的Priority，并且结合返回值中的Version一起使用处理规则。" } ] }, { "name": "PolicyStatistics", "type": "object", "required": false, "description": "安全组策略条目统计。只用于出参。", "example": "{\"IngressIPv4TotalCount\": 1, \"IngressIPv6TotalCount\": 0, \"EgressIPv4TotalCount\": 1, \"EgressIPv6TotalCount\": 0}", "children": [ { "name": "IngressIPv4TotalCount", "type": "integer", "required": true, "description": "入站IPv4总数", "example": "1" }, { "name": "IngressIPv6TotalCount", "type": "integer", "required": true, "description": "入站IPv6总数", "example": "1" }, { "name": "EgressIPv4TotalCount", "type": "integer", "required": true, "description": "出站IPv4总数", "example": "1" }, { "name": "EgressIPv6TotalCount", "type": "integer", "required": true, "description": "出站IPv6总数", "example": "1" } ] } ] } ], "required": [ "SecurityGroupId", "SecurityGroupPolicySet" ] }, { "name": "DeleteServiceTemplate", "description": "本接口（DeleteServiceTemplate）用于删除协议端口模板。 \u003e?本接口为异步接口，可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果，待任务执行成功后再进行其他操作。 \u003e", "status": "online", "parameters": [ { "name": "ServiceTemplateId", "type": "string", "required": true, "description": "协议端口模板实例ID，例如：ppm-e6dy460g。", "example": "pm-e6dy460g" } ], "required": [ "ServiceTemplateId" ] }, { "name": "DeleteServiceTemplateGroup", "description": "本接口（DeleteServiceTemplateGroup）用于删除协议端口模板集合。 \u003e?本接口为异步接口，可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果，待任务执行成功后再进行其他操作。 \u003e", "status": "online", "parameters": [ { "name": "ServiceTemplateGroupId", "type": "string", "required": true, "description": "协议端口模板集合实例ID，例如：ppmg-n17uxvve。", "example": "ppmg-n17uxvve" } ], "required": [ "ServiceTemplateGroupId" ] }, { "name": "DeleteSnapshotPolicies", "description": "本接口（DeleteSnapshotPolicies）用于删除快照策略。", "status": "online", "parameters": [ { "name": "SnapshotPolicyIds", "type": "array", "required": true, "description": "快照策略Id。", "example": "[\"sspolicy-0mrp8xzp\"]", "item_type": "string" } ], "required": [ "SnapshotPolicyIds" ] }, { "name": "DeleteSubnet", "description": "本接口（DeleteSubnet）用于删除子网（Subnet）。 * 删除子网前，请清理该子网下所有资源，包括云服务器、负载均衡、云数据、NoSQL、弹性网卡等资源。", "status": "online", "parameters": [ { "name": "SubnetId", "type": "string", "required": true, "description": "子网实例ID。可通过DescribeSubnets接口返回值中的SubnetId获取。", "example": "subnet-pxir56ns" } ], "required": [ "SubnetId" ] }, { "name": "DeleteTemplateMember", "description": "删除模板对象中的IP地址、协议端口、IP地址组、协议端口组。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "参数模板实例ID，支持IP地址、协议端口、IP地址组、协议端口组四种参数模板的实例ID。", "example": "ipm-test1234" }, { "name": "TemplateMember", "type": "array", "required": true, "description": "需要添加的参数模板成员信息，支持IP地址、协议端口、IP地址组、协议端口组四种类型，类型需要与TemplateId参数类型一致。", "example": "无", "item_type": "object", "children": [ { "name": "Member", "type": "string", "required": true, "description": "模板对象成员", "example": "ipm-h0fk8lfc" }, { "name": "Description", "type": "string", "required": false, "description": "模板对象成员描述信息", "example": "demo" } ] } ], "required": [ "TemplateId", "TemplateMember" ] }, { "name": "DeleteTrafficMirror", "description": "本接口（DeleteTrafficMirror）用于删除流量镜像实例。", "status": "online", "parameters": [ { "name": "TrafficMirrorId", "type": "string", "required": true, "description": "流量镜像实例ID", "example": "imgf-cvfp7xo8" } ], "required": [ "TrafficMirrorId" ] }, { "name": "DeleteTrafficPackages", "description": "删除共享带宽包（仅非活动状态的流量包可删除）。", "status": "online", "parameters": [ { "name": "TrafficPackageIds", "type": "array", "required": true, "description": "待删除的流量包唯一ID数组", "example": " ['tfp-djrccqtx']", "item_type": "string" } ], "required": [ "TrafficPackageIds" ] }, { "name": "DeleteVpc", "description": "本接口（DeleteVpc）用于删除私有网络。 * 删除前请确保 VPC 内已经没有相关资源，例如云服务器、云数据库、NoSQL、VPN网关、专线网关、负载均衡、对等连接、与之互通的基础网络设备等。 * 删除私有网络是不可逆的操作，请谨慎处理。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。", "example": "vpc-3ptx9s8b" } ], "required": [ "VpcId" ] }, { "name": "DeleteVpcEndPoint", "description": "本接口（DeleteVpcEndPoint）用于删除终端节点。", "status": "online", "parameters": [ { "name": "EndPointId", "type": "string", "required": true, "description": "终端节点ID。可通过[DescribeVpcEndPoint](https://cloud.tencent.com/document/product/215/54679) 获取。", "example": "vpce-h0fk8lfc" }, { "name": "IpAddressType", "type": "string", "required": false, "description": "协议类型，支持 Ipv4，Ipv6，默认 Ipv4。", "example": "Ipv4" } ], "required": [ "EndPointId" ] }, { "name": "DeleteVpcEndPointService", "description": "本接口（DeleteVpcEndPointService）用于删除终端节点服务。限制：当有终端节点关联到终端节点服务时，无法删除终端节点服务。", "status": "online", "parameters": [ { "name": "EndPointServiceId", "type": "string", "required": true, "description": "终端节点ID。可通过[DescribeVpcEndPointService](https://cloud.tencent.com/document/product/215/54678)接口获取。", "example": "vpcsvc-kngiybxl" }, { "name": "IpAddressType", "type": "string", "required": false, "description": "协议类型，支持 Ipv4，Ipv6，默认 Ipv4。", "example": "Ipv4" } ], "required": [ "EndPointServiceId" ] }, { "name": "DeleteVpcEndPointServiceWhiteList", "description": "本接口（DeleteVpcEndPointServiceWhiteList）用于删除终端节点服务白名单。", "status": "online", "parameters": [ { "name": "UserUin", "type": "array", "required": true, "description": "用户UIN数组。登录 腾讯云账号中心控制台", "example": "['2126195383']", "item_type": "string" }, { "name": "EndPointServiceId", "type": "string", "required": true, "description": "终端节点服务ID。可通过[DescribeVpcEndPointService](https://cloud.tencent.com/document/product/215/54678)接口获取。", "example": "vpcsvc-b2mrmmx7" } ], "required": [ "UserUin", "EndPointServiceId" ] }, { "name": "DeleteVpcPeeringConnection", "description": "本接口（DeleteVpcPeeringConnection）用于删除私有网络对等连接。", "status": "online", "parameters": [ { "name": "PeeringConnectionId", "type": "string", "required": true, "description": "对等连接唯一ID。", "example": "pcx-r2kt047o" } ], "required": [ "PeeringConnectionId" ] }, { "name": "DeleteVpnConnection", "description": "本接口（DeleteVpnConnection）用于删除VPN通道。 \u003e?本接口为异步接口 \u003e", "status": "online", "parameters": [ { "name": "VpnGatewayId", "type": "string", "required": true, "description": "VPN网关实例ID。", "example": "vpngw-xxx" }, { "name": "VpnConnectionId", "type": "string", "required": true, "description": "VPN通道实例ID。形如：vpnx-f49l6u0z。", "example": "vpnx-f49l6u0z" } ], "required": [ "VpnGatewayId", "VpnConnectionId" ] }, { "name": "DeleteVpnGateway", "description": "本接口（DeleteVpnGateway）用于删除VPN网关。", "status": "online", "parameters": [ { "name": "VpnGatewayId", "type": "string", "required": true, "description": "VPN网关实例ID。", "example": "vpngw-ox3thdg1" } ], "required": [ "VpnGatewayId" ] }, { "name": "DeleteVpnGatewayRoutes", "description": "本接口（DeleteVpnGatewayRoutes）用于删除VPN网关路由", "status": "online", "parameters": [ { "name": "VpnGatewayId", "type": "string", "required": true, "description": "VPN网关实例ID", "example": "vpngw-12345678" }, { "name": "RouteIds", "type": "array", "required": true, "description": "路由ID信息列表，可以通过[DescribeVpnGatewayRoutes](https://cloud.tencent.com/document/api/215/57676)接口查询。", "example": "[\"xxx-xxxx\\n\",\"xxx-xxxx\\n\"]", "item_type": "string" } ], "required": [ "VpnGatewayId", "RouteIds" ] }, { "name": "DeleteVpnGatewaySslClient", "description": "本接口（DeleteVpnGatewaySslClient）用于删除SSL-VPN-CLIENT。", "status": "online", "parameters": [ { "name": "SslVpnClientId", "type": "string", "required": false, "description": "SSL-VPN-CLIENT 实例ID。不可和SslVpnClientIds同时使用。", "example": "vpnc-123456" }, { "name": "SslVpnClientIds", "type": "array", "required": false, "description": "SSL-VPN-CLIENT 实例ID列表。批量删除时使用。不可和SslVpnClientId同时使用。", "example": "[\"vpnc-123456\"]", "item_type": "string" } ], "required": [] }, { "name": "DeleteVpnGatewaySslServer", "description": "删除SSL-VPN-SERVER 实例", "status": "online", "parameters": [ { "name": "SslVpnServerId", "type": "string", "required": true, "description": "SSL-VPN-SERVER 实例ID。", "example": "vpngwSslServer-123456" } ], "required": [ "SslVpnServerId" ] }, { "name": "DescribeAccountAttributes", "description": "本接口（DescribeAccountAttributes）用于查询用户账号私有属性。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeAddressBandwidthRange", "description": "本接口（DescribeAddressBandwidthRange）用于查询指定EIP的带宽上下限范围。", "status": "online", "parameters": [ { "name": "AddressIds", "type": "array", "required": false, "description": "EIP资源ID列表，单次查询上限20，可以使用[DescribeAddresses](https://cloud.tencent.com/document/product/215/16702)接口获取AddressId。", "example": "[\"eip-test1234\", \"eip-1234test\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeAddressQuota", "description": "本接口 (DescribeAddressQuota) 用于查询您账户的[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)（简称 EIP）在当前地域的配额信息。配额详情可参见 [EIP 产品简介](https://cloud.tencent.com/document/product/213/5733)。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeAddressTemplateGroupInstances", "description": "本接口（DescribeAddressTemplateGroupInstances）用于查询参数模板IP地址组口关联的实例列表。本接口不会返回查询的结果，需要根据返回的RequestId调用DescribeVpcTaskResult接口获取结果。", "status": "online", "parameters": [ { "name": "AddressTemplateGroupId", "type": "string", "required": true, "description": "IP地址组实例ID。例如：ipmg-12345678。", "example": "ipmg-12345678" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" } ], "required": [ "AddressTemplateGroupId" ] }, { "name": "DescribeAddressTemplateGroups", "description": "本接口（DescribeAddressTemplateGroups）用于查询IP地址模板集合。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 address-template-group-name - String - （过滤条件）IP地址模板集合名称。 address-template-group-id - String - （过滤条件）IP地址模板实集合例ID，例如：ipmg-mdunqeb6。", "example": "[{\"Name\": \"address-template-group-id\", \"Values\": [\"ipmg-mdunqeb6\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "string", "required": false, "description": "偏移量，默认为0。", "example": "1" }, { "name": "Limit", "type": "string", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" }, { "name": "NeedMemberInfo", "type": "boolean", "required": false, "description": "是否查询IP地址模板成员标识。", "example": "false" }, { "name": "OrderField", "type": "string", "required": false, "description": "排序字段。支持：`AddressTemplateGroupId ` `CreatedTime` `UpdateTime`。注意：该字段没有默认值。", "example": "UpdatedTime" }, { "name": "OrderDirection", "type": "string", "required": false, "description": "排序方法。升序：`ASC`，倒序：`DESC`。注意：该字段没有默认值。", "example": "DESC" }, { "name": "MemberOrderField", "type": "string", "required": false, "description": "IP地址成员排序字段。支持：`AddressTemplateId` `UpdateTime`。注意：该字段没有默认值。", "example": "UpdatedTime" }, { "name": "MemberOrderDirection", "type": "string", "required": false, "description": "IP地址成员排序方法。升序：`ASC`，倒序：`DESC`。注意：该字段没有默认值。", "example": "DESC" } ], "required": [] }, { "name": "DescribeAddressTemplateInstances", "description": "本接口（DescribeAddressTemplateInstances）用于查询参数模板IP地址关联的实例列表。本接口不会返回查询的结果，需要根据返回的RequestId调用DescribeVpcTaskResult接口获取结果。", "status": "online", "parameters": [ { "name": "AddressTemplateId", "type": "string", "required": true, "description": "IP地址实例ID。例如：ipm-12345678。", "example": "ipm-12345678" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" } ], "required": [ "AddressTemplateId" ] }, { "name": "DescribeAddressTemplates", "description": "本接口（DescribeAddressTemplates）用于查询IP地址模板。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 address-template-name - IP地址模板名称。 address-template-id - IP地址模板实例ID，例如：ipm-mdunqeb6。 address-ip - IP地址。", "example": "[{\"Name\": \"address-template-id\", \"Values\": [\"ipm-ol7ec22a\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "string", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "string", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" }, { "name": "NeedMemberInfo", "type": "boolean", "required": false, "description": "是否获取IP地址模板成员标识。", "example": "false" }, { "name": "OrderField", "type": "string", "required": false, "description": "排序字段。支持：`AddressTemplateId` `CreatedTime` `UpdateTime`。注意：该字段没有默认值。", "example": "UpdatedTime" }, { "name": "OrderDirection", "type": "string", "required": false, "description": "排序方法。升序：`ASC`，倒序：`DESC`。注意：该字段没有默认值。", "example": "DESC" }, { "name": "MemberOrderField", "type": "string", "required": false, "description": "IP成员排序字段。支持：`Address` `UpdateTime`。注意：该字段没有默认值。", "example": "UpdatedTime" }, { "name": "MemberOrderDirection", "type": "string", "required": false, "description": "IP成员排序方法。升序：`ASC`，倒序：`DESC`。注意：该字段没有默认值。", "example": "DESC" } ], "required": [] }, { "name": "DescribeAddresses", "description": "本接口 (DescribeAddresses) 用于查询一个或多个[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)（简称 EIP）的详细信息。 * 如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的 EIP。", "status": "online", "parameters": [ { "name": "AddressIds", "type": "array", "required": false, "description": "标识 EIP 的唯一 ID 列表。EIP 唯一 ID 形如：`eip-11112222`。可以使用[DescribeAddresses](https://cloud.tencent.com/document/product/215/16702)接口获取AddressId。参数不支持同时指定`AddressIds`和`Filters.address-id`。", "example": "[\"eip-11112222\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "每次请求的`Filters`的上限为10，`Filter.Values`的上限为100。详细的过滤条件如下： address-id - String - 是否必填：否 - （过滤条件）按照 EIP 的唯一 ID 过滤。EIP 唯一 ID 形如：eip-11112222。可以使用[DescribeAddresses](https://cloud.tencent.com/document/product/215/16702)接口获取address-id。 address-name - String - 是否必填：否 - （过滤条件）按照 EIP 名称过滤。不支持模糊过滤。可以使用[DescribeAddresses](https:/...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API 中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API 中的相关小节。", "example": "20" } ], "required": [] }, { "name": "DescribeAssistantCidr", "description": "本接口（DescribeAssistantCidr）用于查询辅助CIDR列表。", "status": "online", "parameters": [ { "name": "VpcIds", "type": "array", "required": false, "description": "`VPC`实例`ID`数组。形如：[`vpc-6v2ht8q5`]", "example": "vpc-6v2ht8q5", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定VpcIds和Filters。 当前支持的过滤条件如下： vpc-id - String - （过滤条件）VPC实例ID，形如：vpc-f49l6u0z。（当前仅支持该过滤条件）", "example": "[{\"Name\": \"vpc-id\", \"Values\": [\"vpc-6v2ht8q5\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" } ], "required": [] }, { "name": "DescribeBandwidthPackageBandwidthRange", "description": "查询指定带宽包的带宽上下限范围", "status": "online", "parameters": [ { "name": "BandwidthPackageIds", "type": "array", "required": false, "description": "带宽包资源ID列表，单次查询上限20。可以使用[DescribeBandwidthPackages](https://cloud.tencent.com/document/product/215/19209)接口查询BandwidthPackageId。", "example": "['bwp-1234test', 'bwp-test1234']", "item_type": "string" } ], "required": [] }, { "name": "DescribeBandwidthPackageBillUsage", "description": "本接口 (DescribeBandwidthPackageBillUsage) 用于查询后付费共享带宽包当前的计费用量.", "status": "online", "parameters": [ { "name": "BandwidthPackageId", "type": "string", "required": true, "description": "后付费共享带宽包的唯一ID，可以使用[DescribeBandwidthPackages](https://cloud.tencent.com/document/api/215/19209)接口获取BandwidthPackageId。", "example": "bwp-pply3nak" } ], "required": [ "BandwidthPackageId" ] }, { "name": "DescribeBandwidthPackageQuota", "description": "接口用于查询账户在当前地域的带宽包上限数量以及使用数量", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeBandwidthPackageResources", "description": "本接口 (DescribeBandwidthPackageResources) 用于根据共享带宽包唯一ID查询共享带宽包内的资源列表，支持按条件过滤查询结果和分页查询。", "status": "online", "parameters": [ { "name": "BandwidthPackageId", "type": "string", "required": true, "description": "标识 共享带宽包 的唯一 ID 列表。共享带宽包 唯一 ID 形如：`bwp-11112222`。", "example": "bwp-7umnal1o" }, { "name": "Filters", "type": "array", "required": false, "description": "每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。详细的过滤条件如下： resource-id - String - 是否必填：否 - （过滤条件）按照 共享带宽包内资源 的唯一 ID 过滤。共享带宽包内资源 唯一 ID 形如：eip-11112222。 resource-type - String - 是否必填：否 - （过滤条件）按照 共享带宽包内资源 类型过滤，目前仅支持 弹性IP 和 负载均衡 两种类型，可选值为 Address 和 LoadBalance。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/11646)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/11646)中的相关小节。", "example": "20" } ], "required": [ "BandwidthPackageId" ] }, { "name": "DescribeBandwidthPackages", "description": "接口用于查询带宽包详细信息，包括带宽包唯一标识ID，类型，计费模式，名称，资源信息等", "status": "online", "parameters": [ { "name": "BandwidthPackageIds", "type": "array", "required": false, "description": "带宽包唯一ID列表", "example": "bwp-ofoubyyt", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "每次请求的`Filters`的上限为10。参数不支持同时指定`BandwidthPackageIds`和`Filters`。详细的过滤条件如下： bandwidth-package-id - String - 是否必填：否 - （过滤条件）按照带宽包的唯一标识ID过滤。 bandwidth-package-name - String - 是否必填：否 - （过滤条件）按照 带宽包名称过滤。不支持模糊过滤。 network-type - String - 是否必填：否 - （过滤条件）按照带宽包的类型过滤。网络类型可参考[Bandw...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "查询带宽包偏移量，默认为0。关于Offset的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小结。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询带宽包返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小结。", "example": "20" } ], "required": [] }, { "name": "DescribeCcnAttachedInstances", "description": "本接口（DescribeCcnAttachedInstances）用于查询云联网实例下已关联的网络实例。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件： ccn-id - String -（过滤条件）CCN实例ID。 instance-type - String -（过滤条件）关联实例类型。 instance-region - String -（过滤条件）关联实例所属地域。 instance-id - String -（过滤条件）关联实例ID。", "example": "[{\"Name\":\"ccn-id\",\"Values\":[\"ccn-nb107zhp\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "CcnId", "type": "string", "required": false, "description": "云联网实例ID", "example": "ccn-245ecr35" }, { "name": "OrderField", "type": "string", "required": false, "description": "排序字段。支持：`CcnId` `InstanceType` `InstanceId` `InstanceName` `InstanceRegion` `AttachedTime` `State`。默认值：`AttachedTime`", "example": "CcnId" }, { "name": "OrderDirection", "type": "string", "required": false, "description": "排序方法。升序：`ASC`，倒序：`DESC`。默认值：`ASC`", "example": "ASC" } ], "required": [] }, { "name": "DescribeCcnPolicyBasedRoutingNextHop", "description": "查询云联网策略路由下一跳", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "云联网 ID", "example": "ccn-7bw2xi31" }, { "name": "Offset", "type": "string", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "string", "required": false, "description": "返回数量", "example": "10" } ], "required": [ "CcnId" ] }, { "name": "DescribeCcnPolicyBasedRoutingRule", "description": "查询云联网策略路由匹配规则", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "云联网 ID", "example": "ccn-7bw2xi31" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量", "example": "10" } ], "required": [ "CcnId" ] }, { "name": "DescribeCcnRegionBandwidthLimits", "description": "本接口（DescribeCcnRegionBandwidthLimits）用于查询云联网各地域出带宽上限，该接口只返回已关联网络实例包含的地域。", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "CCN实例ID，形如：ccn-f49l6u0z。", "example": "ccn-f49l6u0z" } ], "required": [ "CcnId" ] }, { "name": "DescribeCcnRouteTableBroadcastPolicys", "description": "本接口(DescribeCcnRouteTableBroadcastPolicys)用于查询指定云联网路由表的路由传播策略。", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "云联网ID", "example": "ccn-qd6z2ld1" }, { "name": "RouteTableId", "type": "string", "required": true, "description": "云联网路由表ID", "example": "ccnrtb-1mkezrkd" }, { "name": "PolicyVersion", "type": "integer", "required": false, "description": "路由传播策略版本号", "example": "10" } ], "required": [ "CcnId", "RouteTableId" ] }, { "name": "DescribeCcnRouteTableInputPolicys", "description": "本接口(DescribeCcnRouteTableInputPolicys)用于查询指定云联网路由表的路由接收策略。", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "云联网ID。", "example": "ccn-qd6z2ld1" }, { "name": "RouteTableId", "type": "string", "required": true, "description": "云联网路由表ID。", "example": "ccnrtb-1mkezrkd" }, { "name": "PolicyVersion", "type": "integer", "required": false, "description": "路由接收策略版本号。", "example": "10" } ], "required": [ "CcnId", "RouteTableId" ] }, { "name": "DescribeCcnRouteTables", "description": "该接口用于查询指定的云联网实例的路由表信息。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件： ccn-id - String -（过滤条件）CCN实例ID。 route-table-id - String -（过滤条件）路由表ID。 route-table-name - String -（过滤条件）路由表名称。 route-table-description- String -（过滤条件）路由表备注。", "example": "[{\"Name\":\"route-id\",\"Values\":[\"ccnr-bvipc87w\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "一次查询最大返回的数量。", "example": "20" } ], "required": [] }, { "name": "DescribeCcnRoutes", "description": "本接口（DescribeCcnRoutes）用于查询已加入云联网（CCN）的路由。", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "CCN实例ID，形如：`ccn-gree226l`。", "example": "ccn-gree226l" }, { "name": "RouteIds", "type": "array", "required": false, "description": "CCN路由策略唯一ID，形如：`ccnr-f49l6u0z`。", "example": "['ccnr-bvipc87w']", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定RouteIds和Filters。 route-id - String -（过滤条件）路由策略ID。 cidr-block - String -（过滤条件）目的端。 instance-type - String -（过滤条件）下一跳类型。 instance-region - String -（过滤条件）下一跳所属地域。 instance-id - String -（过滤条件）下一跳实例ID。 route-table-id - String -（过滤条件）路由表ID列表，形如ccntr-1234edfr，可以根据路由表ID 过滤。", "example": "[{\"Name\":\"route-id\",\"Values\":[\"ccnr-bvipc87w\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量", "example": "10" } ], "required": [ "CcnId" ] }, { "name": "DescribeCcns", "description": "本接口（DescribeCcns）用于查询云联网（CCN）列表。", "status": "online", "parameters": [ { "name": "CcnIds", "type": "array", "required": false, "description": "CCN实例ID。形如：ccn-f49l6u0z。每次请求的实例的上限为100。参数不支持同时指定CcnIds和Filters。", "example": "ccn-f49l6u0z", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定CcnIds和Filters。 ccn-id - String - （过滤条件）CCN唯一ID，形如：`ccn-f49l6u0z`。 ccn-name - String - （过滤条件）CCN名称。 ccn-description - String - （过滤条件）CCN描述。 state - String - （过滤条件）实例状态， 'ISOLATED': 隔离中（欠费停服），'AVAILABLE'：运行中。 tag-key - String -是否必填：否- （过滤条件）按照标签键进行过滤。 tag:tag-key - String - 是否必填：否 - \ufffd...", "example": "[{\"Name\":\"uniqVbcId\",\"Values\":[\"ccn-bvipc87w\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量", "example": "20" }, { "name": "OrderField", "type": "string", "required": false, "description": "排序字段。支持：`CcnId` `CcnName` `CreateTime` `State` `QosLevel`。默认值: `CreateTime`", "example": "CcnName" }, { "name": "OrderDirection", "type": "string", "required": false, "description": "排序方法。升序：`ASC`，倒序：`DESC`。默认值：`ASC`", "example": "ASC" } ], "required": [] }, { "name": "DescribeCdcLDCXList", "description": "查询 IDC通道信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeCdcNetPlanes", "description": "查询虚拟连接", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeCdcUsedIdcVlan", "description": "查询IDC使用的 VLAN", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeClassicLinkInstances", "description": "本接口（DescribeClassicLinkInstances）用于查询私有网络和基础网络设备互通列表。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 vpc-id - String - （过滤条件）VPC实例ID。 vm-ip - String - （过滤条件）基础网络云服务器IP。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "vpc-id" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "[\"vpc-pnpcflil\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "string", "required": false, "description": "偏移量，默认值0。", "example": "0" }, { "name": "Limit", "type": "string", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" } ], "required": [] }, { "name": "DescribeCrossBorderCcnRegionBandwidthLimits", "description": "本接口（DescribeCrossBorderCcnRegionBandwidthLimits）用于获取要锁定的限速实例列表。 该接口一般用来封禁地域间限速的云联网实例下的限速实例, 目前联通内部运营系统通过云API调用, 如果是出口限速, 一般使用更粗的云联网实例粒度封禁（DescribeTenantCcns） 如有需要, 可以封禁任意限速实例, 可接入到内部运营系统", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，目前`value`值个数只支持一个，可支持的字段有： `source-region` 源地域，值形如：`[\"ap-guangzhou\"]` `destination-region` 目的地域，值形如：`[\"ap-shanghai\"]` `ccn-ids` 云联网ID数组，值形如：`[\"ccn-12345678\"]` `user-account-id` 用户账号ID，值形如`[\"12345678\"]`", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "单页返回数据量可选值0到100之间的整数，默认20。", "example": "20" } ], "required": [] }, { "name": "DescribeCrossBorderCompliance", "description": "本接口（DescribeCrossBorderCompliance）用于查询用户创建的合规化资质审批单。 服务商可以查询服务名下的任意 `APPID` 创建的审批单；非服务商，只能查询自己审批单。", "status": "online", "parameters": [ { "name": "ServiceProvider", "type": "string", "required": false, "description": "（精确匹配）服务商，可选值：`UNICOM`。", "example": "UNICOM" }, { "name": "ComplianceId", "type": "integer", "required": false, "description": "（精确匹配）合规化审批单`ID`。", "example": "10002" }, { "name": "Company", "type": "string", "required": false, "description": "（模糊查询）公司名称。", "example": "腾讯科技（广州）有限公司" }, { "name": "UniformSocialCreditCode", "type": "string", "required": false, "description": "（精确匹配）统一社会信用代码。", "example": "91440101327598294H" }, { "name": "LegalPerson", "type": "string", "required": false, "description": "（模糊查询）法定代表人。", "example": "张颖" }, { "name": "LegalPersonId", "type": "string", "required": false, "description": "（精确查询）法人身份证号。", "example": "360732199007108888" }, { "name": "IssuingAuthority", "type": "string", "required": false, "description": "（模糊查询）发证机关。", "example": "广州市海珠区市场监督管理局" }, { "name": "BusinessAddress", "type": "string", "required": false, "description": "（模糊查询）营业执照住所。", "example": "广州市海珠区新港中路397号自编72号(商业街F5-1)" }, { "name": "PostCode", "type": "integer", "required": false, "description": "（精确匹配）邮编。", "example": "510320" }, { "name": "Manager", "type": "string", "required": false, "description": "（模糊查询）经办人。", "example": "李四" }, { "name": "ManagerId", "type": "string", "required": false, "description": "（精确查询）经办人身份证号。", "example": "360732199007108888" }, { "name": "ManagerAddress", "type": "string", "required": false, "description": "（模糊查询）经办人身份证地址。", "example": "广州市海珠区新港中路8888号" }, { "name": "ManagerTelephone", "type": "string", "required": false, "description": "（精确匹配）经办人联系电话。", "example": "020-81167888" }, { "name": "Email", "type": "string", "required": false, "description": "（精确匹配）电子邮箱。", "example": "test@tencent.com" }, { "name": "ServiceStartDate", "type": "string", "required": false, "description": "（精确匹配）服务开始日期，如：`2020-07-28`。", "example": "2020-07-29" }, { "name": "ServiceEndDate", "type": "string", "required": false, "description": "（精确匹配）服务结束日期，如：`2021-07-28`。", "example": "2021-07-29" }, { "name": "State", "type": "string", "required": false, "description": "（精确匹配）状态。待审批：`PENDING`，通过：`APPROVED `，拒绝：`DENY`。", "example": "PENDING" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量", "example": "20" } ], "required": [] }, { "name": "DescribeCrossBorderFlowMonitor", "description": "本接口（DescribeCrossBorderFlowMonitor）用于查询跨境带宽监控数据，该接口目前只提供给服务商联通使用。", "status": "online", "parameters": [ { "name": "SourceRegion", "type": "string", "required": true, "description": "源地域。", "example": "ap-guangzhou" }, { "name": "DestinationRegion", "type": "string", "required": true, "description": "目的地域。", "example": "na-siliconvalley" }, { "name": "CcnId", "type": "string", "required": true, "description": "云联网ID。", "example": "ccn-gree226l" }, { "name": "CcnUin", "type": "string", "required": true, "description": "云联网所属账号。", "example": "251223380" }, { "name": "Period", "type": "integer", "required": true, "description": "时间粒度。单位为:秒，如60为60s的时间粒度", "example": "60" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间。", "example": "2022-08-20 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间。", "example": "2022-08-20 00:10:00" } ], "required": [ "SourceRegion", "DestinationRegion", "CcnId", "CcnUin", "Period", "StartTime", "EndTime" ] }, { "name": "DescribeCustomerGatewayVendors", "description": "本接口（DescribeCustomerGatewayVendors）用于查询可支持的对端网关厂商信息。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeCustomerGateways", "description": "本接口（DescribeCustomerGateways）用于查询对端网关列表。", "status": "online", "parameters": [ { "name": "CustomerGatewayIds", "type": "array", "required": false, "description": "对端网关ID，例如：cgw-2wqq41m9。每次请求的实例的上限为100。参数不支持同时指定CustomerGatewayIds和Filters。", "example": "cgw-2wqq41m9", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，详见下表：实例过滤条件表。每次请求的Filters的上限为10，Filter.Values的上限为5。参数不支持同时指定CustomerGatewayIds和Filters。 customer-gateway-id - String - （过滤条件）用户网关唯一ID形如：`cgw-mgp33pll`。 customer-gateway-name - String - （过滤条件）用户网关名称形如：`test-cgw`。 ip-address - String - （过滤条件）公网地址形如：`58.211.1.12`。", "example": "null", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于Offset的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/11646)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "10" } ], "required": [] }, { "name": "DescribeDesignatedZones", "description": "用于查询用户创建带宽包时可指定的可用区信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeDhcpIps", "description": "本接口（DescribeDhcpIps）用于查询DhcpIp列表", "status": "online", "parameters": [ { "name": "DhcpIpIds", "type": "array", "required": false, "description": "DhcpIp实例ID。形如：dhcpip-pxir56ns。每次请求的实例的上限为100。参数不支持同时指定DhcpIpIds和Filters。", "example": "[\"dhcpip-12345678\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定DhcpIpIds和Filters。 vpc-id - String - （过滤条件）VPC实例ID，形如：vpc-f49l6u0z。 subnet-id - String - （过滤条件）所属子网实例ID，形如：subnet-f49l6u0z。 dhcpip-id - String - （过滤条件）DhcpIp实例ID，形如：dhcpip-pxir56ns。 dhcpip-name - String - （过滤条件）DhcpIp实例名称。 address-ip - String - （过滤条件）DhcpIp实例的IP，根据IP精确查找。", "example": "[{\"Name\": \"vpc-id\", \"Values\": [\"vpc-n0yejvje\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" } ], "required": [] }, { "name": "DescribeDirectConnectGatewayCcnRoutes", "description": "本接口（DescribeDirectConnectGatewayCcnRoutes）用于查询专线网关的云联网路由（IDC网段）", "status": "online", "parameters": [ { "name": "DirectConnectGatewayId", "type": "string", "required": true, "description": "专线网关ID，形如：`dcg-prpqlmg1`。", "example": "dcg-prpqlmg1" }, { "name": "CcnRouteType", "type": "string", "required": false, "description": "云联网路由学习类型，可选值： `BGP` - 自动学习。 `STATIC` - 静态，即用户配置，默认值。", "example": "BGP" }, { "name": "AddressType", "type": "string", "required": false, "description": "地址类型，支持：IPv4、IPv6。默认IPv4。", "example": "IPv4" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量。", "example": "20" } ], "required": [ "DirectConnectGatewayId" ] }, { "name": "DescribeDirectConnectGateways", "description": "本接口（DescribeDirectConnectGateways）用于查询专线网关。", "status": "online", "parameters": [ { "name": "DirectConnectGatewayIds", "type": "array", "required": false, "description": "专线网关唯一`ID`，形如：`dcg-9o233uri`。", "example": "[\"dcg-dimeg9zd\\r\\n\",\"dcg-6eeis68f\\r\\n\",\"dcg-94cdyvfr\\r\\n\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定`DirectConnectGatewayIds`和`Filters`。 direct-connect-gateway-id - String - 专线网关唯一`ID`，形如：`dcg-9o233uri`。 direct-connect-gateway-name - String - 专线网关名称，默认模糊查询。 direct-connect-gateway-ip - String - 专线网关`IP`。 gateway-type - String - 网关类型，可选值：`NORMAL`（普通型）、`NAT`（NAT型）。 network-type- String - 网络类型，可选值：`VPC`（私有网络类型）、`CCN`（\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量。", "example": "20" } ], "required": [] }, { "name": "DescribeFlowLog", "description": "本接口（DescribeFlowLog）用于查询VPC流日志实例信息。 该接口只支持VPC流日志（即将下线）。云联网以及VPC流日志，通过[DescribeFlowLogs](https://cloud.tencent.com/document/product/215/35012)接口获取。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "私用网络唯一ID。可通过[DescribeVpcs](https://cloud.tencent.com/document/product/215/15778)接口获取。该接口不支持拉取CCN类型的流日志，所以该字段为必选。", "example": "vpc-hj3he929" }, { "name": "FlowLogId", "type": "string", "required": true, "description": "流日志唯一ID。可通过[CreateFlowLog](https://cloud.tencent.com/document/product/215/35015)接口创建；可通过[DescribeFlowLogs](https://cloud.tencent.com/document/product/215/35012)接口获取；", "example": "fl-nswq8wkq" } ], "required": [ "VpcId", "FlowLogId" ] }, { "name": "DescribeFlowLogs", "description": "本接口（DescribeFlowLogs）用于查询获取流日志集合。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": false, "description": "私用网络唯一ID。可通过[DescribeVpcs](https://cloud.tencent.com/document/product/215/15778)接口获取。", "example": "vpc-7zayowkt" }, { "name": "FlowLogId", "type": "string", "required": false, "description": "流日志唯一ID。可通过[CreateFlowLog](https://cloud.tencent.com/document/product/215/35015)接口创建。", "example": "fl-hdtpam45" }, { "name": "FlowLogName", "type": "string", "required": false, "description": "流日志实例名称。长度不超过60个字符。", "example": "FlowLogName1" }, { "name": "ResourceType", "type": "string", "required": false, "description": "流日志所属资源类型，VPC（私有网络），SUBNET（子网），NETWORKINTERFACE（网卡），CCN（云联网），NAT（网络地址转化），DCG（专线网关）。", "example": "VPC" }, { "name": "ResourceId", "type": "string", "required": false, "description": "资源唯一ID。", "example": "vpc-7zayowkt" }, { "name": "TrafficType", "type": "string", "required": false, "description": "流日志采集类型，ACCEPT（允许），REJECT（拒绝），ALL（全部）。", "example": "ACCEPT" }, { "name": "CloudLogId", "type": "string", "required": false, "description": "流日志存储ID。", "example": "10acf9c5-ac0a-45ea-8aeb-bd00312aeebb" }, { "name": "CloudLogState", "type": "string", "required": false, "description": "流日志存储ID状态。SUCCESS（成功），DELETED（删除）", "example": "SUCCESS" }, { "name": "OrderField", "type": "string", "required": false, "description": "按某个字段排序,支持字段：flowLogName,createTime，默认按createTime。", "example": "createTime" }, { "name": "OrderDirection", "type": "string", "required": false, "description": "升序（ASC）还是降序（DESC）,默认：DESC。", "example": "DESC" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页行数，默认为10。范围1-100。", "example": "10" }, { "name": "Filters", "type": "object", "required": false, "description": "过滤条件，参数不支持同时指定FlowLogId和Filters。 tag-key - String -是否必填：否- （过滤条件）按照标签键进行过滤。 tag:tag-key - String - 是否必填：否 - （过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。", "example": "[{\"Name\": \"tag-key\", \"Values\": [\"prod\"]}]", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "CloudLogRegion", "type": "string", "required": false, "description": "流日志存储ID对应的地域信息。", "example": "ap-guangzhou" } ], "required": [] }, { "name": "DescribeGatewayFlowMonitorDetail", "description": "本接口（DescribeGatewayFlowMonitorDetail）用于查询网关流量监控明细。 * 只支持单个网关实例查询。即入参 `VpnId`、 `DirectConnectGatewayId`、 `PeeringConnectionId`、 `NatId` 最多只支持传一个，且必须传一个。 * 如果网关有流量，但调用本接口没有返回数据，请在控制台对应网关详情页确认是否开启网关流量监控。", "status": "online", "parameters": [ { "name": "TimePoint", "type": "string", "required": true, "description": "时间点。表示要查询这分钟内的明细。如：`2019-02-28 18:15:20`，将查询 `18:15` 这一分钟内的明细。", "example": "2019-02-28 18:15:20" }, { "name": "VpnId", "type": "string", "required": false, "description": "VPN网关实例ID，形如：`vpn-ltjahce6`。", "example": "vpn-ltjahce6" }, { "name": "DirectConnectGatewayId", "type": "string", "required": false, "description": "专线网关实例ID，形如：`dcg-ltjahce6`。", "example": "dcg-ltjahce6" }, { "name": "PeeringConnectionId", "type": "string", "required": false, "description": "对等连接实例ID，形如：`pcx-ltjahce6`。", "example": "pcx-ltjahce6" }, { "name": "NatId", "type": "string", "required": false, "description": "NAT网关实例ID，形如：`nat-ltjahce6`。", "example": "nat-ltjahce6" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" }, { "name": "OrderField", "type": "string", "required": false, "description": "排序字段。支持 `InPkg` `OutPkg` `InTraffic` `OutTraffic`，标准型nat额外支持 并发连接数`ConcurrentConnectionCount` 、新建连接速率`NewConnectionRate`。默认值`OutTraffic`。", "example": "InPkg" }, { "name": "OrderDirection", "type": "string", "required": false, "description": "排序方法。顺序：`ASC`，倒序：`DESC`。默认值`DESC`。", "example": "ASC" }, { "name": "PrivateIpAddress", "type": "string", "required": false, "description": "VPC内部IPv4地址，精确匹配", "example": "10.0.1.2" } ], "required": [ "TimePoint" ] }, { "name": "DescribeGatewayFlowQos", "description": "本接口（DescribeGatewayFlowQos）用于查询网关来访IP流控带宽。", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关实例ID，目前我们支持的网关实例类型有， 专线网关实例ID，形如，`dcg-ltjahce6`； Nat网关实例ID，形如，`nat-ltjahce6`； VPN网关实例ID，形如，`vpn-ltjahce6`。", "example": "vpngw-4je9dgin" }, { "name": "IpAddresses", "type": "array", "required": false, "description": "限流的云服务器内网IP。", "example": "[\"10.0.0.12\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" } ], "required": [ "GatewayId" ] }, { "name": "DescribeGlobalRoutes", "description": "查询全局路由列表。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 global-route-id - String - （过滤条件）如全局路由唯一 Id，形如：gr-bmenrwu2。 vpc-id - String - （过滤条件）VPC唯一Id， 形如： vpc-mcqaoy0f。 gateway-id - String - （过滤条件）下一跳对象。 gateway-type - String - 是否必填：否 - （过滤条件）按下一跳类型进行过滤。支持 NORMAL_CVM cdc-id - String - （过滤条件）CDC实例ID，形如：cluster-gbo27yc4。 description - String - （过滤条件）描述。 dest-cid...", "example": "[{ \"Name\": \"vpc-id\", \"Values\": [\"vpc-mcqaoy0f\"]} ]}", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "请求对象个数。", "example": "10" }, { "name": "GlobalRouteIds", "type": "array", "required": false, "description": "全局路由唯一Id列表。", "example": "[\"gr-bmenrwu2\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeHaVips", "description": "本接口（DescribeHaVips）用于查询高可用虚拟IP（HAVIP）列表。", "status": "online", "parameters": [ { "name": "HaVipIds", "type": "array", "required": false, "description": "`HAVIP`唯一`ID`，形如：`havip-9o233uri`。", "example": "[\"havip-bk4275i0\",\"havip-2kce8v4q\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定`HaVipIds`和`Filters`。havip-id - String - `HAVIP`唯一`ID`，形如：`havip-9o233uri`。havip-name - String - `HAVIP`名称。vpc-id - String - `HAVIP`所在私有网络`ID`。subnet-id - String - `HAVIP`所在子网`ID`。vip - String - `HAVIP`的地址`VIP`。address-ip - String - `HAVIP`绑定的弹性公网`IP`。havip-association.instance-id - String - `HAVIP`绑定的子机或网卡。havip-association.instance-type - String - `HAVIP`绑定的...", "example": "[{\"Name\": \"havip-id\", \"Values\"; [\"havip-bk4275i0\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" } ], "required": [] }, { "name": "DescribeHighPriorityRouteTables", "description": "查询高优路由表。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定HighPriorityRouteTableIds和Filters。 high-priority-route-table-id - String - （过滤条件）高优路由表实例ID。 name - String - （过滤条件）高优路由表名称。 vpc-id - String - （过滤条件）VPC实例ID，形如：vpc-f49l6u0z。 tag-key - String -是否必填：否 - （过滤条件）按照标签键进行过滤。 next-hop-type - String - 是否必填：否 - （过滤条件）按下一跳类型进行过滤。使用next-hop-...", "example": "[{\"Name\":\"high-priority-route-table-id\", \"Values\": [\"hprtb-18mot1fm\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "HighPriorityRouteTableIds", "type": "array", "required": false, "description": "高优路由表实例ID，例如：hprtb-18mot1fm。", "example": "[\"hprtb-18mot1fm\"]", "item_type": "string" }, { "name": "Offset", "type": "string", "required": false, "description": "偏移量。", "example": "0" }, { "name": "Limit", "type": "string", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "1" }, { "name": "NeedRouterInfo", "type": "boolean", "required": false, "description": "是否需要获取路由策略信息，默认获取，当控制台不需要拉取路由策略信息时，改为False。", "example": "false" } ], "required": [] }, { "name": "DescribeHighPriorityRoutes", "description": "查询高优路由表条目信息。", "status": "online", "parameters": [ { "name": "HighPriorityRouteTableId", "type": "string", "required": true, "description": "高优路由表唯一 ID。", "example": "hprtb-18mot1fm" }, { "name": "Filters", "type": "array", "required": false, "description": "gateway-id - String - （过滤条件）网关ID。 description - String - （过滤条件）路由描述。 dest-cidr - String - （过滤条件）目的端地址，支持模糊左匹配。 subnet-route-algorithm - String - （过滤条件）现在支持的算法有：ECMP_QUINTUPLE_HASH：五元组hash，ECMP_SOURCE_DESTINATION_IP_HASH：源和目的IP hash，ECMP_DESTINATION_IP_HASH：目的IP hash，ECMP_SOURCE_IP_HASH：源IP hash。 is-cdc - String - （过滤条件）CDC属性高优路由...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "请求对象个数。", "example": "20" } ], "required": [ "HighPriorityRouteTableId" ] }, { "name": "DescribeIPv6Addresses", "description": "本接口（DescribeIPv6Addresses）用于查询一个或多个弹性公网 IPv6（简称 EIPv6）实例的详细信息。 - 支持查询您在指定地域的弹性公网 IPv6 和传统弹性公网 IPv6 实例信息 - 如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的 EIPv6。", "status": "online", "parameters": [ { "name": "IPv6AddressIds", "type": "array", "required": false, "description": "标识 IPv6 的唯一 ID 列。可以使用[DescribeIPv6Addresses](https://cloud.tencent.com/document/api/215/113677)接口获取IPv6AddressId。 - 传统弹性公网 IPv6 唯一 ID 形如：`eip-11112222` - 弹性公网 IPv6 唯一 ID 形如：`eipv6-11112222` 注意：参数不支持同时指定`IPv6AddressIds`和`Filters`。", "example": "[\"eipv6-kxjsieow\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "每次请求的`Filters`的上限为10，`Filter.Values`的上限为100。参数不支持同时指定`IPv6AddressIds`和`Filters`。详细的过滤条件如下： - address-id - String - 是否必填：否 - （过滤条件）按照弹性公网IPv6的唯一ID过滤。 - public-ipv6-address - String - 是否必填：否 - （过滤条件）按照公网 IPv6 的 IP 地址过滤。 - network-interface-id - String - 是否必填：否 - （过滤条件）按照弹性网卡的唯一ID过滤。 - inst...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Traditional", "type": "boolean", "required": false, "description": "是否查询传统型IPv6地址信息。可选值： True：查询传统型IPv6地址信息 False：不查询传统型IPv6地址信息 默认值：False", "example": "False" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于Offset的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/11646)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/11646)中的相关小节。", "example": "20" } ], "required": [] }, { "name": "DescribeInstanceJumbo", "description": "本接口用于检查云服务器是否支持巨帧。 使用限制： 1. 需要CAM策略授权该接口的操作权限，并且授权对应实例的读取权限(该接口会访问CVM实例，所以会校验是否有实例的CAM权限)。例如：CAM action放通vpc:DescribeInstanceJumbo；resource放通qcs::cvm:ap-guangzhou:uin/2126195383:instance/*。 2. 实例迁移前后，可能会出现该接口返回的巨帧状态前后不一致（需要检查迁移前后实例所在的宿主机是否都...", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "CVM实例ID列表。限制每次i最多查询10个实例。", "example": "[\"ins-4uhk90pu\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "DescribeIp6Addresses", "description": "本接口（DescribeIp6Addresses）用于查询一个或多个传统弹性公网 IPv6 实例的详细信息。", "status": "online", "parameters": [ { "name": "Ip6AddressIds", "type": "array", "required": false, "description": "标识 IPv6 的唯一 ID 列表。IPv6 唯一 ID 形如：`eip-11112222`。参数不支持同时指定`Ip6AddressIds`和`Filters`。可以使用[DescribeIp6Addresses](https://cloud.tencent.com/document/product/215/40089)接口查询Ip6AddressIds。", "example": "[\"eip-ciel20fd\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "每次请求的`Filters`的上限为10，`Filter.Values`的上限为100。参数不支持同时指定`AddressIds`和`Filters`。详细的过滤条件如下： address-ip - String - 是否必填：否 - （过滤条件）按照 IPv6 的 IP 地址过滤。可以使用[DescribeIp6Addresses](https://cloud.tencent.com/document/product/215/40089)接口查询address-ip。 network-interface-id - String - 是否必填：否 - （过滤条件）按照弹性网卡的唯一ID过滤。可以使用[DescribeNe...", "example": "\"Values\": [ \"2402:4e00:1000:2d00:0:8f3f:6:9895\" ],\u003cbr\u003e \"Name\": \"address-ip\"", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/11646)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/11646)中的相关小节。", "example": "20" } ], "required": [] }, { "name": "DescribeIp6TranslatorQuota", "description": "查询账户在指定地域IPV6转换实例和规则的配额", "status": "online", "parameters": [ { "name": "Ip6TranslatorIds", "type": "array", "required": false, "description": "待查询IPV6转换实例的唯一ID列表，形如ip6-xxxxxxxx", "example": "ip6-89defcp0", "item_type": "string" } ], "required": [] }, { "name": "DescribeIp6Translators", "description": "1. 该接口用于查询账户下的IPV6转换实例及其绑定的转换规则信息 2. 支持过滤查询", "status": "online", "parameters": [ { "name": "Ip6TranslatorIds", "type": "array", "required": false, "description": "IPV6转换实例唯一ID数组，形如ip6-xxxxxxxx", "example": "ip6-pfkw84ug", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。参数不支持同时指定`Ip6TranslatorIds`和`Filters`。详细的过滤条件如下： ip6-translator-id - String - 是否必填：否 - （过滤条件）按照IPV6转换实例的唯一ID过滤,形如ip6-xxxxxxx。 ip6-translator-vip6 - String - 是否必填：否 - （过滤条件）按照IPV6地址过滤。不支持模糊过滤。 ip6-translator-name - String - 是否必填：否 - （过滤条件）按照IPV6转换\ufffd\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/11646)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/11646)中的相关小节。", "example": "20" } ], "required": [] }, { "name": "DescribeIpGeolocationDatabaseUrl", "description": "本接口（DescribeIpGeolocationDatabaseUrl）用于获取IP地理位置库下载链接。 本接口即将下线，仅供存量用户使用，暂停新增用户。", "status": "online", "parameters": [ { "name": "Type", "type": "string", "required": true, "description": "IP地理位置库协议类型，目前仅支持\"ipv4\"。", "example": "ipv4" } ], "required": [ "Type" ] }, { "name": "DescribeIpGeolocationInfos", "description": "本接口（DescribeIpGeolocationInfos）用于查询IP地址信息，包括地理位置信息和网络信息。 本接口即将下线，仅供存量客户使用，暂停新增用户。", "status": "online", "parameters": [ { "name": "AddressIps", "type": "array", "required": true, "description": "需查询的IP地址列表，目前仅支持IPv4地址。查询的IP地址数量上限为100个。", "example": "[\"8.8.8.8\"]", "item_type": "string" }, { "name": "Fields", "type": "object", "required": false, "description": "需查询的IP地址的字段信息。", "example": "无", "children": [ { "name": "Country", "type": "boolean", "required": false, "description": "国家字段信息", "example": "true" }, { "name": "Province", "type": "boolean", "required": false, "description": "省、州、郡一级行政区域字段信息", "example": "true" }, { "name": "City", "type": "boolean", "required": false, "description": "市一级行政区域字段信息", "example": "true" }, { "name": "Region", "type": "boolean", "required": false, "description": "市内区域字段信息", "example": "true" }, { "name": "Isp", "type": "boolean", "required": false, "description": "接入运营商字段信息", "example": "true" }, { "name": "AsName", "type": "boolean", "required": false, "description": "骨干运营商字段信息", "example": "true" }, { "name": "AsId", "type": "boolean", "required": false, "description": "骨干As号", "example": "true" }, { "name": "Comment", "type": "boolean", "required": false, "description": "注释字段", "example": "true" } ] } ], "required": [ "AddressIps" ] }, { "name": "DescribeLocalGateway", "description": "本接口（DescribeLocalGateway）用于查询CDC的本地网关。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "支持的过滤条件如下: vpc-id:按照VPCID过滤。 local-gateway-name:本地网关名称,支持模糊查询。 local-gateway-id:本地网关实例ID。 cdc-id:cdc实例ID。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/11646)中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/11646)中的相关小节。", "example": "20" } ], "required": [] }, { "name": "DescribeNatGatewayDestinationIpPortTranslationNatRules", "description": "本接口（DescribeNatGatewayDestinationIpPortTranslationNatRules）用于查询NAT网关端口转发规则对象数组。", "status": "online", "parameters": [ { "name": "NatGatewayIds", "type": "array", "required": false, "description": "NAT网关ID。", "example": "[\"nat-3isn9hr0\\r\\n\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件: 参数不支持同时指定NatGatewayIds和Filters。每次请求的Filters的上限为10，Filter.Values的上限为5 nat-gateway-id，NAT网关的ID，如`nat-0yi4hekt` vpc-id，私有网络VPC的ID，如`vpc-0yi4hekt` public-ip-address， 弹性IP，如`139.199.232.238`。 public-port， 公网端口。 private-ip-address， 内网IP，如`10.0.0.1`。 private-port， 内网端口。 description，规则描述。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "10" } ], "required": [] }, { "name": "DescribeNatGatewayDirectConnectGatewayRoute", "description": "查询专线绑定NAT的路由", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "nat的唯一标识", "example": "nat-2jd1e1rm" }, { "name": "VpcId", "type": "string", "required": true, "description": "vpc的唯一标识", "example": "vpc-ofos1s33" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询NAT网关绑定的路由数量，可选值0-200，默认为10", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，默认为0", "example": "0" } ], "required": [ "NatGatewayId", "VpcId" ] }, { "name": "DescribeNatGatewayFlowMonitorDetail", "description": "本接口（DescribeNatGatewayFlowMonitorDetail）用于查询NAT网关流量监控明细。 - 只支持单个网关实例查询。即入参 `NatGatewayId` 最多只支持传一个，且必须传一个。 - 如果网关有流量，但调用本接口没有返回数据，请在控制台对应网关详情页确认是否开启网关流量监控。", "status": "online", "parameters": [ { "name": "TimePoint", "type": "string", "required": true, "description": "时间点。表示要查询的时刻。聚合粒度为60、300时，会查询最近一个整分钟开始的聚合周期；聚合粒度为3600时，会查询最近一个整点开始的聚合周期；聚合粒度为86400时，会查询最近一个整天开始的聚合周期。形如：`2019-03-24T10:51:23+08:00`。", "example": "2019-03-24T10:51:23+08:00" }, { "name": "NatGatewayId", "type": "string", "required": true, "description": "NAT网关的ID，形如：`nat-ig8xpno8`。", "example": "nat-ig8xpno8" }, { "name": "TopN", "type": "integer", "required": false, "description": "展示排序靠前的数据。默认值：10，表示默认展示排序前 10 的数据。最大值：100。", "example": "10" }, { "name": "OrderField", "type": "string", "required": false, "description": "排序字段。支持：入包量`InPkg`、出包量`OutPkg`、入流量`InTraffic`、出流量`OutTraffic`，标准型nat额外支持 并发连接数`ConcurrentConnectionCount` 、新建连接速率`NewConnectionRate`。默认值`OutTraffic`。", "example": "InTraffic" }, { "name": "AggregationTimeRange", "type": "integer", "required": false, "description": "聚合时间粒度。支持：60、300、3600、86400，即按照1分钟、5分钟、1小时、1天进行聚合查询。", "example": "60" }, { "name": "AllMetricMode", "type": "boolean", "required": false, "description": "是否查询全部指标。默认值：True，表示查询全部指标。", "example": "True" } ], "required": [ "TimePoint", "NatGatewayId" ] }, { "name": "DescribeNatGatewaySourceIpTranslationNatRules", "description": "本接口（DescribeNatGatewaySourceIpTranslationNatRules）用于查询NAT网关SNAT转发规则对象数组。", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "NAT网关统一 ID，形如：`nat-123xx454`。", "example": "nat-3isn9hr0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件: resource-id，Subnet的ID或者Cvm ID，如`subnet-0yi4hekt` public-ip-address，弹性IP，如`139.199.232.238` description，规则描述。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "10" } ], "required": [ "NatGatewayId" ] }, { "name": "DescribeNatGatewayZones", "description": "本接口(DescribeNatGatewayZones)用于查询NAT网关可售卖的可用区信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeNatGateways", "description": "本接口（DescribeNatGateways）用于查询 NAT 网关。", "status": "online", "parameters": [ { "name": "NatGatewayIds", "type": "array", "required": false, "description": "NAT网关统一 ID，形如：`nat-123xx454`。每次请求的实例上限为100。参数不支持同时指定NatGatewayIds和Filters。", "example": "[\"nat-3isn9hr0\",\"nat-mxkohguo\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定NatGatewayIds和Filters。每次请求的Filters的上限为10，Filter.Values的上限为5。nat-gateway-id - String - （过滤条件）NAT实例ID，形如：`nat-123xx454`。vpc-id - String - （过滤条件）私有网络 唯一ID，形如：`vpc-123xx454`。nat-gateway-name - String - （过滤条件）协议端口模板实例名称，形如：`test_nat`。tag-key - String - （过滤条件）标签键，形如：`test-key`。nat-state - String - \ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "10" } ], "required": [] }, { "name": "DescribeNetDetectStates", "description": "本接口(DescribeNetDetectStates)用于查询网络探测验证结果列表。", "status": "online", "parameters": [ { "name": "NetDetectIds", "type": "array", "required": false, "description": "网络探测实例`ID`数组。形如：[`netd-12345678`]。", "example": "[\"netd-6v2ht8q5\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定NetDetectIds和Filters。 net-detect-id - String - （过滤条件）网络探测实例ID，形如：netd-12345678。", "example": "[{\"Name\": \"net-detect-id\", \"Values\": [\"netd-6v2ht8q5\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" } ], "required": [] }, { "name": "DescribeNetDetects", "description": "本接口（DescribeNetDetects）用于查询网络探测列表。", "status": "online", "parameters": [ { "name": "NetDetectIds", "type": "array", "required": false, "description": "网络探测实例`ID`数组。形如：[`netd-12345678`]。", "example": "[\"netd-pnpcflil\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定NetDetectIds和Filters。 vpc-id - String - （过滤条件）VPC实例ID，形如：vpc-12345678 net-detect-id - String - （过滤条件）网络探测实例ID，形如：netd-12345678 subnet-id - String - （过滤条件）子网实例ID，形如：subnet-12345678 net-detect-name - String - （过滤条件）网络探测名称", "example": "[{\"Name\": \"vpc-id\", \"Values\": [\"vpc-kngiybxl\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" } ], "required": [] }, { "name": "DescribeNetworkAccountType", "description": "判断用户在网络侧的用户类型，如标准（带宽上移），传统（非上移）。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeNetworkAclQuintupleEntries", "description": "本接口（DescribeNetworkAclQuintupleEntries）查询入方向或出方向网络ACL五元组条目列表。", "status": "online", "parameters": [ { "name": "NetworkAclId", "type": "string", "required": true, "description": "网络ACL实例ID。形如：acl-12345678。", "example": "acl-pnpcflil" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最小值为1，最大值为100。", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定`NetworkAclId`和`Filters`。 protocol - String - 协议，形如：`TCP`。 description - String - 描述。 destination-cidr - String - 目的CIDR， 形如：'192.168.0.0/24'。 source-cidr- String - 源CIDR， 形如：'192.168.0.0/24'。 action - String - 动作，形如ACCEPT或DROP。 network-acl-quintuple-entry-id - String - 五元组唯一ID，形如：'acli45-ahnu4rv5'。 network-acl-direction - String - 方向，形如：'INGRESS'或'EGRESS'\ufffd\ufffd...", "example": "[{\"Name\": \"network-acl-quintuple-entry-id\", \"Values\": [\"acli45-ahnu4rv5\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] } ], "required": [ "NetworkAclId" ] }, { "name": "DescribeNetworkAcls", "description": "本接口（DescribeNetworkAcls）用于查询网络ACL列表。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定NetworkAclIds和Filters。 vpc-id - String - （过滤条件）VPC实例ID，形如：vpc-12345678。 network-acl-id - String - （过滤条件）网络ACL实例ID，形如：acl-12345678。 network-acl-name - String - （过滤条件）网络ACL实例名称。", "example": "vpc-pnpcflil", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "NetworkAclIds", "type": "array", "required": false, "description": "网络ACL实例ID数组。形如：[acl-12345678]。每次请求的实例的上限为100。参数不支持同时指定NetworkAclIds和Filters。", "example": "[\"acl-nswq8wkq\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最小值为1，最大值为100。", "example": "20" }, { "name": "OrderField", "type": "string", "required": false, "description": "排序字段。支持：NetworkAclId,NetworkAclName,CreatedTime", "example": "CreatedTime" }, { "name": "OrderDirection", "type": "string", "required": false, "description": "排序方法。顺序：ASC，倒序：DESC。", "example": "DESC" } ], "required": [] }, { "name": "DescribeNetworkInterfaceLimit", "description": "本接口（DescribeNetworkInterfaceLimit）根据CVM实例ID或弹性网卡ID查询弹性网卡配额，返回该CVM实例或弹性网卡能绑定的弹性网卡配额，以及弹性网卡可以分配的IP配额。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "要查询的CVM实例ID或弹性网卡ID。", "example": "ins-4lsnc7dz" } ], "required": [ "InstanceId" ] }, { "name": "DescribeNetworkInterfaces", "description": "本接口（DescribeNetworkInterfaces）用于查询弹性网卡列表。", "status": "online", "parameters": [ { "name": "NetworkInterfaceIds", "type": "array", "required": false, "description": "弹性网卡实例ID查询。形如：eni-pxir56ns。每次请求的实例的上限为100。参数不支持同时指定NetworkInterfaceIds和Filters。可通过[DescribeNetworkInterfaces](https://cloud.tencent.com/document/product/215/15817)接口获取。", "example": "[\"eni-f9qln349\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定NetworkInterfaceIds和Filters。 vpc-id - String - （过滤条件）VPC实例ID，形如：vpc-f49l6u0z。可通过可通过[DescribeVpcs](https://cloud.tencent.com/document/product/215/15778)接口获取。 subnet-id - String - （过滤条件）所属子网实例ID，形如：subnet-f49l6u0z。可通过[DescribeSubnets](https://cloud.tencent.com/document/product/215/15784)接口获取。 network-interface-id - String - （过滤条件）弹性网卡\ufffd\ufffd...", "example": "[{'Name': 'vpc-id', 'Values': ['vpc-q26u781x']}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "10" } ], "required": [] }, { "name": "DescribePrivateNatGatewayDestinationIpPortTranslationNatRules", "description": "本接口（DescribePrivateNatGatewayDestinationIpPortTranslationNatRules）用于查询私网NAT网关目的端口转换规则", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "私网网关唯一`ID`，形如\"intranat-xxxxxxxx)", "example": "intranat-0g3blj80" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，Name可选值：OriginalIp、TranslationIp、OriginalPort、TranslationPort、Protocol、Description，分别表示映射前IP、映射后IP、映射前端口、映射后端口、协议类型、描述", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数目，默认值为20。", "example": "20" } ], "required": [ "NatGatewayId" ] }, { "name": "DescribePrivateNatGatewayLimits", "description": "本接口（DescribePrivateNatGatewayLimits）用于查询可创建的私网NAT网关配额数量", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "查询VPC下可创建的私网网关配额数量，可选值： VpcId - String - 所在VpcId", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数目，默认值为20。", "example": "20" } ], "required": [] }, { "name": "DescribePrivateNatGatewayRegions", "description": "本接口（DescribePrivateNatGatewayRegions）用于查询查询私网NAT网关可支持地域", "status": "online", "parameters": [], "required": [] }, { "name": "DescribePrivateNatGatewayTranslationAclRules", "description": "本接口（DescribePrivateNatGatewayTranslationAclRules）用于查询私网NAT网关源端转换访问控制规则", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "私网网关唯一`ID`，形如：`intranat-xxxxxxxx`。", "example": "intranat-0g3blj80" }, { "name": "TranslationDirection", "type": "string", "required": true, "description": "转换规则目标，可选值LOCAL。", "example": "LOCAL" }, { "name": "TranslationType", "type": "string", "required": true, "description": "转换规则类型，可选值NETWORK_LAYER、TRANSPORT_LAYER。分别对应三层、四层。", "example": "NETWORK_LAYER" }, { "name": "TranslationIp", "type": "string", "required": true, "description": "映射后`IP`,当转换规则类型为四层时为`IP`池。", "example": "10.0.13.20" }, { "name": "OriginalIp", "type": "string", "required": false, "description": "映射前`IP`,当转换规则类型为三层时有效。", "example": "10.0.13.19" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数目，默认值为20。", "example": "20" }, { "name": "Description", "type": "string", "required": false, "description": "ACL规则描述", "example": "ACL规则描述" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。AclRuleId - Integer - ACL规则ID。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] } ], "required": [ "NatGatewayId", "TranslationDirection", "TranslationType", "TranslationIp" ] }, { "name": "DescribePrivateNatGatewayTranslationNatRules", "description": "本接口（DescribePrivateNatGatewayTranslationNatRules）用于查询私网NAT网关源端转换规则", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "私网网关唯一`ID`，形如：`intranat-xxxxxxxx`。", "example": "[\"intranat-0g3blj80\"]" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 OriginalIp - String - 转换规则源`IP`。 TranslationIp - String - 转换`IP`。 VpcId - String - 私网网关所在`VpcId`。 Description - String - 转换规则描述", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量。默认值为20。", "example": "20" } ], "required": [ "NatGatewayId" ] }, { "name": "DescribePrivateNatGateways", "description": "本接口（DescribePrivateNatGateways）用于查询私网NAT网关", "status": "online", "parameters": [ { "name": "NatGatewayIds", "type": "array", "required": false, "description": "私网网关唯一`ID`，形如：`intranat-0g3blj80`。 注意：NatGatewayIds和Filters参数互斥，不能同时传入。", "example": "[\"intranat-0g3blj80\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。NatGatewayId - String - 私网网关唯一`ID`，形如：`intranat-0g3blj80`。NatGatewayName - String - 专线网关名称，默认模糊查询。VpcId - String - 私网网关所在`VpcId`。TagKey - Tag数组 - 私网网关标签键值对数组intranat-status - String - （过滤条件）NAT实例当前状态，形如：`AVAILABLE`。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20。", "example": "20" }, { "name": "OrderField", "type": "string", "required": false, "description": "排序字段。可选值：NatGatewayId、NatGatewayName、CreatedTime。", "example": "NatGatewayId" }, { "name": "OrderDirection", "type": "string", "required": false, "description": "排序方式。可选值：ASC、DESC。分别表示升序、降序。", "example": "ASC" } ], "required": [] }, { "name": "DescribeProductQuota", "description": "本接口（DescribeProductQuota）用于查询网络产品的配额信息。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "查询的网络产品名称，可查询的产品有：vpc、ccn、vpn、dc、dfw、clb、eip。", "example": "vpc" } ], "required": [ "Product" ] }, { "name": "DescribeReserveIpAddresses", "description": "查询内网保留 IP", "status": "online", "parameters": [ { "name": "ReserveIpIds", "type": "array", "required": false, "description": "内网保留IP唯一ID 列表", "example": "[\"rsvip-pvqgv9vi\", \"rsvip-calhlymy\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定ReserveIpIds和Filters。 reserve-ip-id - String - （过滤条件）内网保留 IP唯一 ID，形如：rsvip-pvqgv9vi。 vpc-id - String - （过滤条件）VPC实例ID，形如：vpc-f49l6u0z。 subnet-id - String - （过滤条件）所属子网实例ID，形如：subnet-f49l6u0z。 address-ip - String - （过滤条件）内网保留 IP 地址，形如：192.168.0.10。 ip-type - String - （过滤条件）业务类型 ipType，0。 name - String - ...", "example": "[ { \"Name\": \"state\", \"Values\": [ \"UnBind\" ] } ]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "请求对象个数。", "example": "20" } ], "required": [] }, { "name": "DescribeRouteConflicts", "description": "本接口（DescribeRouteConflicts）用于查询自定义路由策略与云联网路由策略冲突列表。", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表实例ID，例如：rtb-azd4dt1c。", "example": "rtb-azd4dt1c" }, { "name": "DestinationCidrBlocks", "type": "array", "required": true, "description": "要检查的与之冲突的目的端列表。", "example": "[\"192.168.0.0/24\", \"10.11.0.0/24\"]", "item_type": "string" } ], "required": [ "RouteTableId", "DestinationCidrBlocks" ] }, { "name": "DescribeRouteList", "description": "本接口（DescribeRouteList）用于查询路由条目列表。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "vpc-id - String - （过滤条件）VPC实例ID，形如：vpc-f49l6u0z。 gateway-id - String - （过滤条件）网关ID。 description - String - （过滤条件）路由描述。 route-table-id - String - （过滤条件）路由表实例ID。 dest-cidr - String - （过滤条件）目的端地址，支持模糊左匹配。", "example": "[{\"Name\": \"route-table-id\", \"Values\": [\"rtb-e187un9p\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "请求对象个数。", "example": "10" } ], "required": [] }, { "name": "DescribeRoutePolicies", "description": "本接口（DescribeRoutePolicies）用于查询路由策略列表。", "status": "online", "parameters": [ { "name": "RoutePolicyIds", "type": "array", "required": false, "description": "路由策略实例唯一ID。形如：rrp-q7ywkx31。每次请求的实例的上限为100。参数不支持同时指定RoutePolicyIds和Filters。", "example": "rrp-q7ywkx3w", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，不支持同时指定RoutePolicyIds和Filters参数。 支持的过滤条件如下： route-policy-name：路由策略实例名称，支持模糊查询。 route-policy-description：路由策略实例描述，支持模糊查询。 route-policy-id ：路由策略实例ID，例如：rrp-q7ywkx3w。 **说明：**若同一个过滤条件（Filter）存在多个Values，则同一Filter下Values间的关系为逻辑或（OR）关系；若存在多个过滤条件（Filter），Filter之\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "string", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "string", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "2" }, { "name": "NeedRoutePolicyEntry", "type": "boolean", "required": false, "description": "是否返回路由策略条目。默认为False。当该参数为False时，仍然会返回空的返回空的RoutePolicyEntrySet。", "example": "True" } ], "required": [] }, { "name": "DescribeRoutePolicyEntries", "description": "本接口（DescribeRoutePolicyEntries）用于查询路由接收策略条目列表。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定RoutePolicyEntryIds和Filters。 route-policy-id - String - （过滤条件）路由接收策略实例ID，形如：rrp-f49l6u0z。 cidr-block - String - （过滤条件）CIDR(只取掩码前的子网部分)，形如：10.0.0.0/8。 priority - Integer - （过滤条件）优先级，形如：20。 gateway-type - String - （过滤条件）下一跳类型，形如：CVM。 gateway-id - String - （过滤条件）下一跳实例唯一ID，形如：ccn-f49...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "请求对象个数。", "example": "10" }, { "name": "OrderField", "type": "string", "required": false, "description": "排序字段。当前只支持优先级Prioriry字段。", "example": "Priority" }, { "name": "OrderDirection", "type": "string", "required": false, "description": "排序方向。 ASC：升序。 DESC：降序。", "example": "ASC" }, { "name": "RoutePolicyEntryIds", "type": "array", "required": false, "description": "路由策略条目ID。", "example": "无", "item_type": "string" } ], "required": [] }, { "name": "DescribeRouteTableAssociatedInstances", "description": "本接口（DescribeRouteTableAssociatedInstances）用于查询指定的云联网关联的实例所绑定的路由表信息。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件： ccn-id - String -（过滤条件）CCN实例ID。 ccn-route-table-id - String -（过滤条件）路由表ID。 instance-type - String -（过滤条件）实例类型： 私有网络: `VPC` 专线网关: `DIRECTCONNECT` 黑石私有网络: `BMVPC` EDGE设备: `EDGE` EDGE隧道: `EDGE_TUNNEL` EDGE网关: `EDGE_VPNGW` VPN网关：`VPNGW` instance-id- String -（过滤条件）实例ID。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "一次查询最大返回的数量。", "example": "20" } ], "required": [] }, { "name": "DescribeRouteTableSelectionPolicies", "description": "本接口（DescribeRouteTableSelectionPolicies）用于查询云联网路由表选择策略。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件： ccn-id - String -（过滤条件）CCN实例ID。 instance-type - String -（过滤条件）关联实例类型: 私有网络: `VPC` 专线网关: `DIRECTCONNECT` 黑石私有网络: `BMVPC` EDGE设备: `EDGE` EDGE隧道: `EDGE_TUNNEL` EDGE网关: `EDGE_VPNGW` VPN网关：`VPNGW` ccn-route-table-id - String -（过滤条件）路由表ID。 instance-id - String -（过滤条件）关联的实例ID。 route-table-name - String -（过滤条件）路由表名称。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeRouteTables", "description": "本接口（DescribeRouteTables）用于查询路由表。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定RouteTableIds和Filters。 route-table-id - String - （过滤条件）路由表实例ID。 route-table-name - String - （过滤条件）路由表名称。 vpc-id - String - （过滤条件）VPC实例ID，形如：vpc-f49l6u0z。 association.main - String - （过滤条件）是否主路由表。 tag-key - String -是否必填：否 - （过滤条件）按照标签键进行过滤。 tag:tag-key - String - 是否必填：否 - （过滤条件）按照\ufffd\ufffd...", "example": "[{\"Name\":\"route-table-id\", \"Values\": [\"rtb-3yuu2t62\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "RouteTableIds", "type": "array", "required": false, "description": "路由表实例ID，例如：rtb-azd4dt1c。", "example": "rtb-l2h8d7c2", "item_type": "string" }, { "name": "Offset", "type": "string", "required": false, "description": "偏移量。", "example": "0" }, { "name": "Limit", "type": "string", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "1" }, { "name": "NeedRouterInfo", "type": "boolean", "required": false, "description": "是否需要获取路由策略信息，默认获取，当控制台不需要拉取路由策略信息时，改为False。", "example": "true" } ], "required": [] }, { "name": "DescribeRoutes", "description": "本接口（DescribeRoutes）用于查询路由列表。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "vpc-id - String - （过滤条件）VPC实例ID，形如：vpc-f49l6u0z。 gateway-id - String - （过滤条件）网关ID。 description - String - （过滤条件）路由描述。 route-table-id - String - （过滤条件）路由表实例ID。 dest-cidr - String - （过滤条件）目的端地址，支持模糊左匹配。", "example": "[{\"Name\": \"route-table-id\", \"Values\": [\"rtb-e187un9p\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "请求对象个数。", "example": "10" } ], "required": [] }, { "name": "DescribeSecurityGroupAssociationStatistics", "description": "本接口（DescribeSecurityGroupAssociationStatistics）用于查询安全组关联的实例统计。", "status": "online", "parameters": [ { "name": "SecurityGroupIds", "type": "array", "required": true, "description": "安全实例ID，例如sg-33ocnj9n，可通过DescribeSecurityGroups获取。", "example": "[\"sg-ohuuioma\\r\\n\",\"sg-2quou3gv\\r\\n\"]", "item_type": "string" } ], "required": [ "SecurityGroupIds" ] }, { "name": "DescribeSecurityGroupExpandedPolicies", "description": "本接口（DescribeSecurityGroupExpandedPolicies）用于查看参数模板展开后的安全组规则。本接口会通过缓存降低请求后端服务的调用次数，因此拉取结果会存在延迟（缓存超时时间为1分钟）。", "status": "online", "parameters": [ { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组实例ID，例如：sg-33ocnj9n，可通过DescribeSecurityGroups获取。", "example": "sg-brf5xqjr" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 security-group-id - String - 规则中的安全组ID。 ip - String - IP，支持IPV4和IPV6模糊匹配。 address-module - String - IP地址模板或IP地址组模板ID。 service-module - String - 协议端口模板或协议端口组模板ID。 protocol-type - String - 安全组策略支持的协议，可选值：`TCP`, `UDP`, `ICMP`, `ICMPV6`, `GRE`, `ALL`。 port - String - 是否必填：否 -协议端口，支持模糊匹配，值为`ALL`时，查询所有的端口。 poly...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] } ], "required": [ "SecurityGroupId" ] }, { "name": "DescribeSecurityGroupLimits", "description": "本接口(DescribeSecurityGroupLimits)用于查询用户安全组配额。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeSecurityGroupPolicies", "description": "本接口（DescribeSecurityGroupPolicies）用于查询安全组规则。", "status": "online", "parameters": [ { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组实例ID，例如：sg-33ocnj9n，可通过DescribeSecurityGroups获取。", "example": "sg-ohuuioma" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 security-group-id - String - 规则中的安全组ID。 ip - String - IP，支持IPV4和IPV6模糊匹配。 address-module - String - IP地址模板或IP地址组模板ID。 service-module - String - 协议端口模板或协议端口组模板ID。 protocol-type - String - 安全组策略支持的协议，可选值：`TCP`, `UDP`, `ICMP`, `ICMPV6`, `GRE`, `ALL`。 port - String - 是否必填：否 -协议端口，支持模糊匹配，值为`ALL`时，查询所有的端口。 poly...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] } ], "required": [ "SecurityGroupId" ] }, { "name": "DescribeSecurityGroupReferences", "description": "本接口（DescribeSecurityGroupReferences）用于查询安全组被引用信息。", "status": "online", "parameters": [ { "name": "SecurityGroupIds", "type": "array", "required": true, "description": "安全组实例ID数组。格式如：['sg-12345678']。", "example": "['sg-12345678']", "item_type": "string" } ], "required": [ "SecurityGroupIds" ] }, { "name": "DescribeSecurityGroups", "description": "本接口（DescribeSecurityGroups）用于查询安全组。", "status": "online", "parameters": [ { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "安全组实例ID，例如：sg-33ocnj9n。每次请求的实例的上限为100。参数不支持同时指定SecurityGroupIds和Filters。", "example": "[\"sg-33ocnj9n\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定SecurityGroupIds和Filters。 security-group-id - String - （过滤条件）安全组ID。 project-id - Integer - （过滤条件）项目ID。 security-group-name - String - （过滤条件）安全组名称。 tag-key - String -是否必填：否- （过滤条件）按照标签键进行过滤。 tag:tag-key - String - 是否必填：否 - （过滤条件）按照标签键值对进行过滤。 其中 tag-key 请使用具体的标签键进行替换。", "example": "[{\"Name\": \"security-group-id\", \"Values\": [\"sg-33ocnj9n\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "string", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "string", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" }, { "name": "OrderField", "type": "string", "required": false, "description": "排序字段。支持：`CreatedTime` `UpdateTime`。注意：该字段没有默认值。", "example": "UpdateTime" }, { "name": "OrderDirection", "type": "string", "required": false, "description": "排序方法。升序：`ASC`，倒序：`DESC`。默认值：`ASC`", "example": "DESC" } ], "required": [] }, { "name": "DescribeServiceTemplateGroupInstances", "description": "本接口（DescribeServiceTemplateGroupInstances）用于查询参数模板协议端口组关联的实例列表。本接口不会返回查询的结果，需要根据返回的RequestId调用DescribeVpcTaskResult接口获取结果。", "status": "online", "parameters": [ { "name": "ServiceTemplateGroupId", "type": "string", "required": true, "description": "协议端口实例ID。例如：ppmg-12345678。", "example": "ppmg-12345678" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" } ], "required": [ "ServiceTemplateGroupId" ] }, { "name": "DescribeServiceTemplateGroups", "description": "本接口（DescribeServiceTemplateGroups）用于查询协议端口模板集合。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 service-template-group-name - String - （过滤条件）协议端口模板集合名称。 service-template-group-id - String - （过滤条件）协议端口模板集合实例ID，例如：ppmg-e6dy460g。", "example": "[{\"Name\":\"service-template-group-name\",\"Value\":\"demo\"}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "string", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "string", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" }, { "name": "NeedMemberInfo", "type": "boolean", "required": false, "description": "是否获取协议端口模板成员标识。", "example": "false" }, { "name": "OrderField", "type": "string", "required": false, "description": "排序字段。支持：`ServiceTemplateGroupId ` `CreatedTime` `UpdateTime`。注意：该字段没有默认值。", "example": "UpdatedTime" }, { "name": "OrderDirection", "type": "string", "required": false, "description": "排序方法。升序：`ASC`，倒序：`DESC`。注意：该字段没有默认值。", "example": "DESC" }, { "name": "MemberOrderField", "type": "string", "required": false, "description": "协议端口成员排序字段。支持：`ServiceTemplateId ` `UpdateTime`。注意：该字段没有默认值。", "example": "UpdatedTime" }, { "name": "MemberOrderDirection", "type": "string", "required": false, "description": "协议端口成员排序方法。升序：`ASC`，倒序：`DESC`。注意：该字段没有默认值。", "example": "DESC" } ], "required": [] }, { "name": "DescribeServiceTemplateInstances", "description": "本接口（DescribeServiceTemplateInstances）用于查询参数模板协议端口关联的实例列表。本接口不会返回查询的结果，需要根据返回的RequestId调用DescribeVpcTaskResult接口获取结果。", "status": "online", "parameters": [ { "name": "ServiceTemplateId", "type": "string", "required": true, "description": "协议端口实例ID。例如：ppm-12345678。", "example": "ppm-12345678" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" } ], "required": [ "ServiceTemplateId" ] }, { "name": "DescribeServiceTemplates", "description": "本接口（DescribeServiceTemplates）用于查询协议端口模板。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 service-template-name - 协议端口模板名称。 service-template-id - 协议端口模板实例ID，例如：ppm-e6dy460g。 service-port- 协议端口。", "example": "[{\"Name\": \"service-template-id\", \"Values\": [\"ppm-e6dy460g\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "string", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "string", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" }, { "name": "NeedMemberInfo", "type": "boolean", "required": false, "description": "是否获取协议端口成员标识。", "example": "false" }, { "name": "OrderField", "type": "string", "required": false, "description": "排序字段。支持：`ServiceTemplateId ` `CreatedTime` `UpdateTime`。注意：该字段没有默认值。", "example": "UpdatedTime" }, { "name": "OrderDirection", "type": "string", "required": false, "description": "排序方法。升序：`ASC`，倒序：`DESC`。注意：该字段没有默认值。", "example": "DESC" }, { "name": "MemberOrderField", "type": "string", "required": false, "description": "协议端口排序字段。支持：`Service ` `UpdateTime`。注意：该字段没有默认值。", "example": "UpdatedTime" }, { "name": "MemberOrderDirection", "type": "string", "required": false, "description": "协议端口排序方法。升序：`ASC`，倒序：`DESC`。注意：该字段没有默认值。", "example": "DESC" } ], "required": [] }, { "name": "DescribeSgSnapshotFileContent", "description": "本接口（DescribeSgSnapshotFileContent）用于查询安全组快照文件内容。", "status": "online", "parameters": [ { "name": "SnapshotPolicyId", "type": "string", "required": true, "description": "快照策略Id。", "example": "sspolicy-hx8an9sr" }, { "name": "SnapshotFileId", "type": "string", "required": true, "description": "快照文件Id。", "example": "ssfile-emtabuwu2z" }, { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组Id。", "example": "sg-ntrgm89v" } ], "required": [ "SnapshotPolicyId", "SnapshotFileId", "SecurityGroupId" ] }, { "name": "DescribeSnapshotAttachedInstances", "description": "本接口（DescribeSnapshotAttachedInstances）用于查询快照策略关联实例列表。", "status": "online", "parameters": [ { "name": "SnapshotPolicyId", "type": "string", "required": true, "description": "快照策略Id。", "example": "sspolicy-hx8an9sr" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 支持的过滤条件如下： instance-id：实例ID。 instance-region：实例所在地域。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大为200。", "example": "20" } ], "required": [ "SnapshotPolicyId" ] }, { "name": "DescribeSnapshotFiles", "description": "本接口（DescribeSnapshotFiles）用于查询快照文件。", "status": "online", "parameters": [ { "name": "BusinessType", "type": "string", "required": true, "description": "业务类型，目前支持安全组：securitygroup。", "example": "securitygroup" }, { "name": "InstanceId", "type": "string", "required": true, "description": "业务实例Id，和BusinessType对应。", "example": "sg-12314a" }, { "name": "StartDate", "type": "string", "required": true, "description": "开始日期，格式%Y-%m-%d %H:%M:%S。", "example": "2021-03-02 14:41:15" }, { "name": "EndDate", "type": "string", "required": true, "description": "结束日期，格式%Y-%m-%d %H:%M:%S。", "example": "2021-03-02 14:41:15" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大为100。", "example": "20" } ], "required": [ "BusinessType", "InstanceId", "StartDate", "EndDate" ] }, { "name": "DescribeSnapshotPolicies", "description": "本接口（DescribeSnapshotPolicies）用于查询快照策略。", "status": "online", "parameters": [ { "name": "SnapshotPolicyIds", "type": "array", "required": false, "description": "快照策略Id。", "example": "[\"sspolicy-g6jwvm35\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定SnapshotPolicyIds和Filters。 snapshot-policy-id - String -（过滤条件）快照策略ID。 snapshot-policy-name - String -（过滤条件）快照策略名称。", "example": "[]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大为200。", "example": "20" } ], "required": [] }, { "name": "DescribeSpecificTrafficPackageUsedDetails", "description": "本接口 (DescribeSpecificTrafficPackageUsedDetails) 用于查询指定 共享流量包 的用量明细。", "status": "online", "parameters": [ { "name": "TrafficPackageId", "type": "string", "required": true, "description": "共享流量包唯一ID。可以使用[DescribeTrafficPackages](https://cloud.tencent.com/document/product/215/80090?locationSource=from%3Ddoc-search%26scope%3Dcurrent%26keyword%3D%E6%B5%81%E9%87%8F%E5%8C%85)接口获取TrafficPackageId。", "example": "tfp-jodl89fe" }, { "name": "Filters", "type": "array", "required": false, "description": "每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。详细的过滤条件如下： resource-type - String - 是否必填：否 - （过滤条件）按照资源类型过滤，资源类型包括 EIP、BWP、LB。 resource-id - String - 是否必填：否 - （过滤条件）按照抵扣流量资源的唯一 ID 过滤。以下补充资源ID获取方式：EIP：可以使用[DescribeAddresses](https://cloud.tencent.com/document/product/215/16702)接口获取资源ID。 BWP：可\ufffd\ufffd...", "example": "\"Values\": [ \"EIP\" ],\u003cbr\u003e \"Name\": \"resource-type\"", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "OrderField", "type": "string", "required": false, "description": "排序条件。该参数仅支持根据抵扣量排序，传值为 deduction", "example": "deduction" }, { "name": "OrderType", "type": "integer", "required": false, "description": "排序类型，仅支持0和1，0-降序，1-升序。不传默认为0", "example": "0" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间。待查询的共享流量包用量开始时间。不传默认为当前时间往前推30天。 时间格式：YYYY-MM-DD hh:mm:ss", "example": "2024-02-04 18:04:03" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间。待查询的共享流量包用量结束时间。不传默认为当前时间。 时间格式：YYYY-MM-DD hh:mm:ss", "example": "2024-02-05 17:04:03" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于Offset的更进一步介绍请参考 API 中的相关小节", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20。关于Limit的更进一步介绍请参考 API 中的相关小节。", "example": "20" } ], "required": [ "TrafficPackageId" ] }, { "name": "DescribeSubnetResourceDashboard", "description": "本接口(DescribeSubnetResourceDashboard)用于查看Subnet资源信息。", "status": "online", "parameters": [ { "name": "SubnetIds", "type": "array", "required": true, "description": "Subnet实例ID，例如：subnet-f1xjkw1b。", "example": "['subnet-xxxxxxxx']", "item_type": "string" } ], "required": [ "SubnetIds" ] }, { "name": "DescribeSubnets", "description": "本接口（DescribeSubnets）用于查询子网列表。", "status": "online", "parameters": [ { "name": "SubnetIds", "type": "array", "required": false, "description": "子网实例ID查询。形如：subnet-pxir56ns。每次请求的实例的上限为100（该参数指定的子网是否返回，需要结合分页拉取参数Limit和Offset）。参数不支持同时指定SubnetIds和Filters。", "example": "[\"subnet-pxir56ns\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定SubnetIds和Filters。 subnet-id - String - （过滤条件）Subnet实例名称。 vpc-id - String - （过滤条件）VPC实例ID，形如：vpc-f49l6u0z。 cidr-block - String - （过滤条件）子网网段，形如: 192.168.1.0 。 is-default - Boolean - （过滤条件）是否是默认子网。 is-remote-vpc-snat - Boolean - （过滤条件）是否为VPC SNAT地址池子网。 subnet-name - String - （过滤条件）子网名称。 zone - Strin...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "string", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "string", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" }, { "name": "MaxResults", "type": "integer", "required": false, "description": "每次调用返回的最大结果数。如果查询返回的时候有NextToken返回，您可以使用NextToken值获取更多页结果， 当NextToke返回空或者返回的结果数量小于MaxResults时，表示没有更多数据了。允许的最大页面大小为 100。", "example": "20" }, { "name": "NextToken", "type": "string", "required": false, "description": "如果NextToken返回非空字符串 ，表示还有更多可用结果。 NextToken是每个页面唯一的分页令牌。使用返回的令牌再次调用以检索下一页。需要保持所有其他参数不变。每个分页令牌在 24 小时后过期。", "example": "\"无\"" } ], "required": [] }, { "name": "DescribeTaskResult", "description": "本接口（DescribeTaskResult）用于查询EIP异步任务执行结果。", "status": "online", "parameters": [ { "name": "TaskId", "type": "integer", "required": false, "description": "异步任务ID。从异步任务接口返回结果中查看。例如：[AllocateAddresses](https://cloud.tencent.com/document/product/215/16699)接口。TaskId和DealName必填一个参数。", "example": "1684395" }, { "name": "DealName", "type": "string", "required": false, "description": "计费订单号。在控制台中的[费用中心-订单管理](https://console.cloud.tencent.com/expense/deal)中查看订单号。TaskId和DealName必填一个参数。", "example": "20241112151073025647301" } ], "required": [] }, { "name": "DescribeTemplateLimits", "description": "本接口（DescribeTemplateLimits）用于查询参数模板配额列表。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeTenantCcns", "description": "本接口（DescribeTenantCcns）用于获取要锁定的云联网实例列表。 该接口一般用来封禁出口限速的云联网实例, 目前联通内部运营系统通过云API调用, 因为出口限速无法按地域间封禁, 只能按更粗的云联网实例粒度封禁, 如果是地域间限速, 一般可以通过更细的限速实例粒度封禁（DescribeCrossBorderCcnRegionBandwidthLimits） 如有需要, 可以封禁任意云联网实例, 可接入到内部运营系统", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，目前`value`值个数只支持一个，允许可支持的字段有： `ccn-ids` 云联网ID数组，值形如：`[\"ccn-12345678\"]` `user-account-id` 用户账号ID，值形如：`[\"12345678\"]``is-security-lock` 是否锁定，值形如：`[\"true\"]`", "example": "[{\"Name\":\"ccn-ids\",\"Values\":[\"ccn-xxxxxxxx\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "单页返回数据量，可选值0到100之间的整数，默认20。", "example": "1" } ], "required": [] }, { "name": "DescribeTrafficMirrors", "description": "本接口（DescribeTrafficMirrors）用于查询流量镜像实例信息。", "status": "online", "parameters": [ { "name": "TrafficMirrorIds", "type": "array", "required": false, "description": "流量镜像实例ID集合", "example": "imgf-cvfp7xo8", "item_type": "string" }, { "name": "Filters", "type": "object", "required": false, "description": "流量镜像查询过滤调节。 vpc-id ：VPC实例ID，例如：vpc-f49l6u0z。 traffic-mirror-id：流量镜像实例ID。 traffic-mirror-name：流量镜像名称。 tag-key ：按照标签键进行过滤。", "example": "无", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" } ], "required": [] }, { "name": "DescribeTrafficPackages", "description": "本接口 (DescribeTrafficPackages) 用于查询共享流量包详细信息，包括共享流量包唯一标识ID，名称，流量使用信息等", "status": "online", "parameters": [ { "name": "TrafficPackageIds", "type": "array", "required": false, "description": "共享流量包ID，支持批量", "example": "[\"tfp-g67jlh1j\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "每次请求的`Filters`的上限为10。参数不支持同时指定`TrafficPackageIds`和`Filters`。详细的过滤条件如下： traffic-package_id - String - 是否必填：否 - （过滤条件）按照共享流量包的唯一标识ID过滤。 traffic-package-name - String - 是否必填：否 - （过滤条件）按照共享流量包名称过滤。不支持模糊过滤。 status - String - 是否必填：否 - （过滤条件）按照共享流量包状态过滤。可选状态：[AVAILABLE...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "分页参数", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页参数", "example": "20" } ], "required": [] }, { "name": "DescribeTrafficQosPolicy", "description": "查询流量调度规则", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "CCN实例ID。形如：ccn-f49l6u0z。", "example": "ccn-gjug0kul" }, { "name": "LocalRegion", "type": "string", "required": true, "description": "本端地域。", "example": "ap-guangzhou" }, { "name": "RemoteRegion", "type": "string", "required": true, "description": "远端地域。", "example": "ap-shanghai" } ], "required": [ "CcnId", "LocalRegion", "RemoteRegion" ] }, { "name": "DescribeUsedIpAddress", "description": "本接口(DescribeUsedIpAddress)用于查询Subnet或者Vpc内的ip的使用情况， 如ip被占用，返回占用ip的资源类别与id；如未被占用，返回空值", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC实例ID。", "example": "vpc-a26u781x" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网实例ID。", "example": "subnet-amqye6ew" }, { "name": "IpAddresses", "type": "array", "required": false, "description": "查询是否占用的ip列表，ip需要在vpc或子网内。最多允许一次查询100个IP。", "example": "[\"192.168.2.10\", \"10.0.1.10\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，不支持同时指定IpAddresses和Filters参数。 支持的过滤条件如下： ip-addresses：IP地址。 resource-id：资源ID。", "example": "[{\"Name\": \"ip-addresses\", \"Values\": [\"10.0.0.10\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "10" } ], "required": [ "VpcId" ] }, { "name": "DescribeVpcEndPoint", "description": "本接口（DescribeVpcEndPoint）用于查询终端节点列表。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。当前支持如下过滤条件： end-point-service-id- String - （过滤条件）终端节点服务ID。可通过[DescribeVpcEndPointService](https://cloud.tencent.com/document/product/215/54678)接口获取。 end-point-name - String - （过滤条件）终端节点实例名称。 end-point-id- String - （过滤条件）终端节点实例ID。可通过[DescribeVpcEndPoint](https://cloud.tencent.com/document/product/215/54679) 接口获取。 vpc-id- String - （过滤条件）...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "单页返回数量，默认为20，最大值为100。", "example": "20" }, { "name": "EndPointId", "type": "array", "required": false, "description": "终端节点ID列表。可通过[DescribeVpcEndPoint](https://cloud.tencent.com/document/product/215/54679) 获取。", "example": "[\"vpce-h0fk8lfc\"]", "item_type": "string" }, { "name": "IpAddressType", "type": "string", "required": false, "description": "协议类型，支持 Ipv4，Ipv6， DualStack，默认 Ipv4。使用DualStack查询双栈的时候，必须要使用MaxResult配合NextToken查询。第1次查询的时候只需要携带MaxResult，如果返回NextToken非空，表示有更多可用数据。第2次查询的时候就需要携带NextToken进行分页查询。", "example": "Ipv4" }, { "name": "MaxResults", "type": "integer", "required": false, "description": "每次调用返回的最大结果数。如果查询返回的时候有NextToken返回，您可以使用NextToken值获取更多页结果， 当NextToke返回空或者返回的结果数量小于MaxResults时，表示没有更多数据了。允许的最大页面大小为 100。", "example": "20" }, { "name": "NextToken", "type": "string", "required": false, "description": "如果NextToken返回非空字符串 ，表示还有更多可用结果。 NextToken是每个页面唯一的分页令牌。使用返回的令牌再次调用以检索下一页。需要保持所有其他参数不变。每个分页令牌在 24 小时后过期。", "example": "\"无\"" } ], "required": [] }, { "name": "DescribeVpcEndPointService", "description": "本接口（DescribeVpcEndPointService）用于查询终端节点服务列表。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。不支持同时传入参数 EndPointServiceIds and Filters。 service-id - String - （过滤条件）终端节点服务唯一ID。可通过[DescribeVpcEndPointService](https://cloud.tencent.com/document/product/215/54678)接口获取。 service-name - String - （过滤条件）终端节点实例名称。 service-instance-id - String - （过滤条件）后端服务的唯一ID，比如lb-dehd3e33。CLB可通过[DescribeLoadBalancers](https://cloud.tencent.com/document/product/110...", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "单页返回数量，默认为20，最大值为100。", "example": "20" }, { "name": "EndPointServiceIds", "type": "array", "required": false, "description": "终端节点服务ID。可通过[DescribeVpcEndPointService](https://cloud.tencent.com/document/product/215/54678)接口获取。不支持同时传入参数 EndPointServiceIds and Filters。", "example": "[\"vpcsvc-pnpcflil\"]", "item_type": "string" }, { "name": "IsListAuthorizedEndPointService", "type": "boolean", "required": false, "description": "不支持同时传入参数 Filters 。 列出授权给当前账号的终端节点服务信息。可以配合EndPointServiceIds参数进行过滤，哪些终端节点服务授权了该账户。", "example": "false" }, { "name": "IpAddressType", "type": "string", "required": false, "description": "协议类型，支持 Ipv4，Ipv6， DualStack，默认 Ipv4。使用DualStack查询双栈的时候，必须要使用MaxResult配合NextToken查询。第1次查询的时候只需要携带MaxResult，如果返回NextToken非空，表示有更多可用数据。第2次查询的时候就需要携带NextToken进行分页查询。", "example": "Ipv4" }, { "name": "MaxResults", "type": "integer", "required": false, "description": "每次调用返回的最大结果数。如果查询返回的时候有NextToken返回，您可以使用NextToken值获取更多页结果， 当NextToke返回空或者返回的结果数量小于MaxResults时，表示没有更多数据了。允许的最大页面大小为 100。", "example": "20" }, { "name": "NextToken", "type": "string", "required": false, "description": "如果NextToken返回 ，表示还有更多可用结果。 NextToken是每个页面唯一的分页令牌。使用返回的令牌再次调用以检索下一页。需要保持所有其他参数不变。每个分页令牌在 24 小时后过期。", "example": "\"无\"" } ], "required": [] }, { "name": "DescribeVpcEndPointServiceWhiteList", "description": "本接口（DescribeVpcEndPointServiceWhiteList）用于查询终端节点服务的服务白名单列表。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "单页返回数量，默认为20，最大值为100。", "example": "0" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 user-uin String - （过滤条件）用户UIN。登录 腾讯云账号中心控制台 获取。 end-point-service-id String - （过滤条件）终端节点服务ID。可通过[DescribeVpcEndPointService](https://cloud.tencent.com/document/product/215/54678)接口获取。", "example": "[{\"Name\":\"end-point-service-id\",\"Values\":[\"vpcsvc-og1w5cum\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeVpcInstances", "description": "本接口（DescribeVpcInstances）用于查询VPC下的云主机实例列表。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": true, "description": "vpc-id - String - （过滤条件）VPC实例ID，形如：vpc-f49l6u0z。 instance-id - String - （过滤条件）云主机实例ID。 instance-name - String - （过滤条件）云主机名称。", "example": "{\"Values\":[\"false\"],\"Name\":\"is-default\"}", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" } ], "required": [ "Filters" ] }, { "name": "DescribeVpcIpv6Addresses", "description": "本接口（DescribeVpcIpv6Addresses）用于查询 `VPC` `IPv6` 信息。 只能查询已使用的`IPv6`信息，当查询未使用的IP时，本接口不会报错，但不会出现在返回结果里。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "`VPC`实例`ID`，形如：`vpc-f49l6u0z`。", "example": "vpc-rkxd3pgh" }, { "name": "Ipv6Addresses", "type": "array", "required": false, "description": "`IP`地址列表，批量查询单次请求最多支持`10`个。", "example": "[\"2402:4e00:1015:4a00::/56\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" }, { "name": "SubnetId", "type": "string", "required": false, "description": "VPC下的子网ID。", "example": "subnet-hx8an9sr" } ], "required": [ "VpcId" ] }, { "name": "DescribeVpcLimits", "description": "本接口（DescribeVpcLimits）用于获取私有网络配额，部分私有网络的配额有地域属性。 LimitTypes取值范围： * appid-max-vpcs （每个开发商每个地域可创建的VPC数）。 * vpc-max-subnets（每个VPC可创建的子网数）。 * vpc-max-route-tables（每个VPC可创建的路由表数）。 * route-table-max-policies（每个路由表可添加的策略数）。 * vpc-max-vpn-gateways（每个VPC可创建的VPN网关数）。 * appid-max-custom-gateways（\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "LimitTypes", "type": "array", "required": true, "description": "配额名称。每次最大查询100个配额类型。", "example": "[\"appid-max-vpcs\"]", "item_type": "string" } ], "required": [ "LimitTypes" ] }, { "name": "DescribeVpcPeeringConnections", "description": "查询私有网络对等连接。", "status": "online", "parameters": [ { "name": "PeeringConnectionIds", "type": "array", "required": false, "description": "对等连接唯一ID数组。", "example": "[\"pcx-test1234\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定PeeringConnectionIds和Filters。 vpc-id - String - （过滤条件）VPC实例ID，形如：vpc-f49l6u0z。 state String - （过滤条件）对等连接状态，可选值有：PENDING，投放中；ACTIVE，使用中；EXPIRED，已过期；REJECTED，拒绝。 peering-connection-name - String - （过滤条件）对等连接名称。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "请求对象个数。", "example": "20" }, { "name": "OrderField", "type": "string", "required": false, "description": "排序字段，可选值有：CreatedTime，PeeringConnectionName。", "example": "CreatedTime" }, { "name": "OrderDirection", "type": "string", "required": false, "description": "排序方式：DESC，降序；ASC，升序。", "example": "DESC" } ], "required": [] }, { "name": "DescribeVpcPrivateIpAddresses", "description": "本接口（DescribeVpcPrivateIpAddresses）用于查询VPC内网IP信息。 只能查询已使用的IP信息，当查询未使用的IP时，本接口不会报错，但不会出现在返回结果里。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "`VPC`实例`ID`，形如：`vpc-f49l6u0z`。", "example": "vpc-rkxd3pgh" }, { "name": "PrivateIpAddresses", "type": "array", "required": true, "description": "内网`IP`地址列表，批量查询单次请求最多支持`100`个。", "example": "[\"10.4.2.2\\n\",\"10.4.2.3\\n\",\"10.4.2.17\\n\"]", "item_type": "string" } ], "required": [ "VpcId", "PrivateIpAddresses" ] }, { "name": "DescribeVpcResourceDashboard", "description": "本接口(DescribeVpcResourceDashboard)用于查看VPC资源信息。", "status": "online", "parameters": [ { "name": "VpcIds", "type": "array", "required": true, "description": "Vpc实例ID，例如：vpc-f1xjkw1b。", "example": "['vpc-q26u781x', 'vpc-1yfqkcw1']", "item_type": "string" } ], "required": [ "VpcIds" ] }, { "name": "DescribeVpcTaskResult", "description": "本接口（DescribeVpcTaskResult）用于查询VPC任务执行结果。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "异步任务请求返回的RequestId。", "example": "481e9b6e-81d1-4859-b8cf-a673e010b388" } ], "required": [ "TaskId" ] }, { "name": "DescribeVpcs", "description": "本接口（DescribeVpcs）用于查询私有网络列表。", "status": "online", "parameters": [ { "name": "VpcIds", "type": "array", "required": false, "description": "VPC实例ID。形如：vpc-f49l6u0z。每次请求的实例的上限为100。参数不支持同时指定VpcIds和Filters。", "example": "[\"vpc-azd4dt1c\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，不支持同时指定VpcIds和Filters参数。 支持的过滤条件如下： vpc-name：VPC实例名称，支持模糊查询。 is-default ：是否默认VPC。 vpc-id ：VPC实例ID，例如：vpc-f49l6u0z。 cidr-block：VPC的CIDR。 tag-key ：按照标签键进行过滤，非必填参数。 tag:tag-key：按照标签键值对进行过滤，非必填参数。 其中 tag-key 请使用具体的标签键进行替换，可参考示例2。 **说明：**若同一个过滤条件（F...", "example": "[{\"Name\": \"vpc-id\", \"Values\": [\"vpc-azd4dt1c\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "string", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "string", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "10" } ], "required": [] }, { "name": "DescribeVpnConnections", "description": "本接口（DescribeVpnConnections）用于查询VPN通道列表。", "status": "online", "parameters": [ { "name": "VpnConnectionIds", "type": "array", "required": false, "description": "VPN通道实例ID。形如：vpnx-f49l6u0z。每次请求的实例的上限为100。参数不支持同时指定VpnConnectionIds和Filters。", "example": "[\"vpnx-f49l6u0z\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。每次请求的Filters的上限为10，Filter.Values的上限为5。参数不支持同时指定VpnConnectionIds和Filters。 vpc-id - String - VPC实例ID，形如：`vpc-0a36uwkr`。 vpn-gateway-id - String - VPN网关实例ID，形如：`vpngw-p4lmqawn`。 customer-gateway-id - String - 对端网关实例ID，形如：`cgw-l4rblw63`。 vpn-connection-name - String - 通道名称，形如：`test-vpn`。 vpn-connection-id - String - 通道实例ID，形如：`vpnx-5p7vkch8\"`。", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "10" } ], "required": [] }, { "name": "DescribeVpnGatewayCcnRoutes", "description": "本接口（DescribeVpnGatewayCcnRoutes）用于查询VPN网关云联网路由。", "status": "online", "parameters": [ { "name": "VpnGatewayId", "type": "string", "required": true, "description": "VPN网关实例ID。", "example": "vpngw-xxx" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。默认值：0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量。默认值：20", "example": "10" } ], "required": [ "VpnGatewayId" ] }, { "name": "DescribeVpnGatewayRoutes", "description": "本接口（DescribeVpnGatewayRoutes）用于查询VPN网关路由。", "status": "online", "parameters": [ { "name": "VpnGatewayId", "type": "string", "required": true, "description": "VPN网关实例ID。", "example": "vpngw-ngenl4az" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件, 条件包括(DestinationCidr, InstanceId,InstanceType)。", "example": "[{\"Name\":\"InstanceType\",\"Values\":[\"vpc\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量, 默认0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "单页个数, 默认20, 最大值100。", "example": "2" } ], "required": [ "VpnGatewayId" ] }, { "name": "DescribeVpnGatewaySslClients", "description": "本接口（DescribeVpnGatewaySslClients）用于查询SSL-VPN-CLIENT 列表。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定SslVpnClientIds和Filters。vpc-id - String - （过滤条件）VPC实例ID形如：vpc-f49l6u0z。vpn-gateway-id - String - （过滤条件）VPN实例ID形如：vpngw-5aluhh9t。ssl-vpn-server-id - String - （过滤条件）SSL-VPN-SERVER实例ID形如：vpns-1j2w6xpx。ssl-vpn-client-id - String - （过滤条件）SSL-VPN-CLIENT实例ID形如：vpnc-3rlxp4nd。ssl-vpn-client-name - String - （过滤条件）SSL-VPN-CLIENT实例名称。ssl-vpn-clie...", "example": "[{\"Name\":\"vpc-id\",\"Values\":[\"vpc-xxxxxxxx\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "请求对象个数，默认值20。", "example": "2" }, { "name": "SslVpnClientIds", "type": "array", "required": false, "description": "SSL-VPN-CLIENT实例ID。形如： vpns-1jww3xpx。每次请求的实例的上限为100。参数不支持同时指定SslVpnClientIds和Filters。", "example": "['vpnc-mgp33pll']", "item_type": "string" }, { "name": "IsVpnPortal", "type": "boolean", "required": false, "description": "VPN门户网站使用。默认是False。", "example": "True" } ], "required": [] }, { "name": "DescribeVpnGatewaySslServers", "description": "本接口（DescribeVpnGatewaySslServers）用于查询SSL-VPN SERVER 列表信息。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "请求对象个数。", "example": "2" }, { "name": "SslVpnServerIds", "type": "array", "required": false, "description": "SSL-VPN-SERVER实例ID。形如：vpns-0p4rj60。每次请求的实例的上限为100。参数不支持同时指定SslVpnServerIds和Filters。", "example": "['vpns-0p4rj60r']", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定SslVpnServerIds和Filters。 vpc-id - String - （过滤条件）VPC实例ID，形如：vpc-f49l6u0z。 vpn-gateway-id - String - （过滤条件）VPN实例ID，形如：vpngw-5aluhh9t。 vpn-gateway-name - String - （过滤条件）VPN实例名称。 ssl-vpn-server-name - String - （过滤条件）SSL-VPN-SERVER实例名称。 ssl-vpn-server-id - String - （过滤条件）SSL-VPN-SERVER实例ID，形如：vpns-xxx。", "example": "[{\"Name\":\"vpc-id\",\"Values\":[\"vpc-xxxxxxxx\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "vpc-id" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "[\"vpc-pnpcflil\"]", "item_type": "string" } ] }, { "name": "IsVpnPortal", "type": "boolean", "required": false, "description": "vpn门户使用。 默认Flase", "example": "False" } ], "required": [] }, { "name": "DescribeVpnGateways", "description": "本接口（DescribeVpnGateways）用于查询VPN网关列表。", "status": "online", "parameters": [ { "name": "VpnGatewayIds", "type": "array", "required": false, "description": "VPN网关实例ID。形如：vpngw-f49l6u0z。每次请求的实例的上限为100。参数不支持同时指定VpnGatewayIds和Filters。", "example": "vpngw-5aluhh9t", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定VpnGatewayIds和Filters。 vpc-id - String - （过滤条件）VPC实例ID形如：vpc-f49l6u0z。 vpn-gateway-id - String - （过滤条件）VPN实例ID形如：vpngw-5aluhh9t。 vpn-gateway-name - String - （过滤条件）VPN实例名称。 type - String - （过滤条件）VPN网关类型：'IPSEC', 'SSL', 'CCN', 'SSL_CCN'。 public-ip-address- String - （过滤条件）公网IP。 renew-flag - String - （过滤条件）网关续费类型，手\ufffd\ufffd...", "example": "[{\"Name\":\"vpn-gateway-id\",\"Values\":[\"vpngw-5aluhh9t\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "vpc-id" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。", "example": "[\"vpc-pnpcflil\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "请求对象个数，默认值为20。", "example": "20" } ], "required": [] }, { "name": "DetachCcnInstances", "description": "本接口（DetachCcnInstances）用于从云联网实例中解关联指定的网络实例。 解关联网络实例后，相应的路由策略会一并删除。", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "CCN实例ID。形如：ccn-f49l6u0z。", "example": "ccn-gree226l" }, { "name": "Instances", "type": "array", "required": true, "description": "要解关联网络实例列表", "example": "[{\"InstanceType\": \"VPC\", \"InstanceId\": \"vpc-rkxd3pgh\", \"InstanceRegion\": \"ap-guangzhou\"}]", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "关联实例ID。", "example": "vpc-lt6ork07" }, { "name": "InstanceRegion", "type": "string", "required": true, "description": "关联实例ID所属大区，例如：ap-guangzhou。", "example": "ap-guangzhou" }, { "name": "InstanceType", "type": "string", "required": true, "description": "关联实例类型，可选值： `VPC`：私有网络 `DIRECTCONNECT`：专线网关 `BMVPC`：黑石私有网络 `VPNGW`：VPNGW类型", "example": "VPC" }, { "name": "Description", "type": "string", "required": false, "description": "备注", "example": "remark" }, { "name": "RouteTableId", "type": "string", "required": false, "description": "实例关联的路由表ID。", "example": "ccnrtb-1234edfr" }, { "name": "OrderType", "type": "string", "required": false, "description": "实例付费方式", "example": "PayByCcnOwner" } ] } ], "required": [ "CcnId", "Instances" ] }, { "name": "DetachClassicLinkVpc", "description": "本接口(DetachClassicLinkVpc)用于删除私有网络和基础网络设备互通。 \u003e?本接口为异步接口，可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果，待任务执行成功后再进行其他操作。 \u003e", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。", "example": "vpc-gjui0b5t" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "CVM实例ID查询。形如：ins-r8hr2upy。", "example": "[\"ins-0x5msjda\"]", "item_type": "string" } ], "required": [ "VpcId", "InstanceIds" ] }, { "name": "DetachNetworkInterface", "description": "本接口（DetachNetworkInterface）用于弹性网卡解绑云服务器。 本接口是异步完成，如需查询异步任务执行结果，请使用本接口返回的`RequestId`轮询[DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口。", "status": "online", "parameters": [ { "name": "NetworkInterfaceId", "type": "string", "required": true, "description": "弹性网卡实例ID，例如：eni-m6dyj72l。可通过[DescribeNetworkInterfaces](https://cloud.tencent.com/document/product/215/15817)接口获取。", "example": "eni-afo43z61" }, { "name": "InstanceId", "type": "string", "required": true, "description": "CVM实例ID。形如：ins-r8hr2upy。可通过[DescribeInstances](https://cloud.tencent.com/document/product/213/15728)接口获取。", "example": "ins-r8hr2upy" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "8ece4b21-c7a4-4e4c-a611-5c412f0e484b" } ], "required": [ "NetworkInterfaceId", "InstanceId" ] }, { "name": "DetachSnapshotInstances", "description": "本接口（DetachSnapshotInstances）用于快照策略解关联实例。", "status": "online", "parameters": [ { "name": "SnapshotPolicyId", "type": "string", "required": true, "description": "快照策略Id。", "example": "sspolicy-hx8an9sr" }, { "name": "Instances", "type": "array", "required": true, "description": "实例信息。", "example": "无", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id。", "example": "sg-123zsda" }, { "name": "InstanceType", "type": "string", "required": true, "description": "实例类型，目前支持安全组：securitygroup。", "example": "securitygroup" }, { "name": "InstanceRegion", "type": "string", "required": true, "description": "实例所在地域。", "example": "ap-guangzhou" }, { "name": "SnapshotPolicyId", "type": "string", "required": false, "description": "快照策略Id。", "example": "sspolicy-hx8an9sr" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称。", "example": "名称" } ] } ], "required": [ "SnapshotPolicyId", "Instances" ] }, { "name": "DisableCcnRoutes", "description": "本接口（DisableCcnRoutes）用于禁用已经启用的云联网（CCN）路由。", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "CCN实例ID。形如：ccn-f49l6u0z。", "example": "ccn-gree226l" }, { "name": "RouteIds", "type": "array", "required": true, "description": "CCN路由策略唯一ID。形如：ccnr-f49l6u0z。可通过DescribeCcnRoutes获取。", "example": "[\"ccnr-bvipc87w\\r\\n\"]", "item_type": "string" } ], "required": [ "CcnId", "RouteIds" ] }, { "name": "DisableFlowLogs", "description": "本接口（DisableFlowLogs）用于停止流日志。", "status": "online", "parameters": [ { "name": "FlowLogIds", "type": "array", "required": true, "description": "流日志Id。可通过[CreateFlowLog](https://cloud.tencent.com/document/product/215/35015)接口创建；可通过[DescribeFlowLogs](https://cloud.tencent.com/document/product/215/35012)接口获取。", "example": "[\"fl-7rymh5cn\"]", "item_type": "string" } ], "required": [ "FlowLogIds" ] }, { "name": "DisableGatewayFlowMonitor", "description": "本接口（DisableGatewayFlowMonitor）用于关闭网关流量监控。", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关实例ID，目前我们支持的网关实例类型有， 专线网关实例ID，形如，`dcg-ltjahce6`； Nat网关实例ID，形如，`nat-ltjahce6`； VPN网关实例ID，形如，`vpn-ltjahce6`。", "example": "vpngw-gree226l" } ], "required": [ "GatewayId" ] }, { "name": "DisableRoutes", "description": "本接口（DisableRoutes）用于禁用已启用的子网路由", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表唯一ID。", "example": "rtb-9wzwlnhc" }, { "name": "RouteIds", "type": "array", "required": false, "description": "路由策略ID。不能和RouteItemIds同时使用，但至少输入一个。该参数取值可通过查询路由列表（[DescribeRouteTables](https://cloud.tencent.com/document/product/215/15763)）获取。", "example": "[\"18292\\n\",\"18293\\n\"]", "item_type": "integer" }, { "name": "RouteItemIds", "type": "array", "required": false, "description": "路由策略唯一ID。不能和RouteIds同时使用，但至少输入一个。该参数取值可通过查询路由列表（[DescribeRouteTables](https://cloud.tencent.com/document/product/215/15763)）获取。", "example": "[\"18292\"]", "item_type": "string" } ], "required": [ "RouteTableId" ] }, { "name": "DisableSnapshotPolicies", "description": "本接口（DisableSnapshotPolicies）用于停用快照策略。", "status": "online", "parameters": [ { "name": "SnapshotPolicyIds", "type": "array", "required": true, "description": "快照策略Id。", "example": "[\"sspolicy-g6jwvm35\"]", "item_type": "string" } ], "required": [ "SnapshotPolicyIds" ] }, { "name": "DisableVpnGatewaySslClientCert", "description": "禁用SSL-VPN-CLIENT 证书", "status": "online", "parameters": [ { "name": "SslVpnClientId", "type": "string", "required": false, "description": "SSL-VPN-CLIENT 实例ID。不可和SslVpnClientIds同时使用。", "example": "vpnc-04ubidcy" }, { "name": "SslVpnClientIds", "type": "array", "required": false, "description": "SSL-VPN-CLIENT 实例ID列表。批量禁用时使用。不可和SslVpnClientId同时使用。", "example": "[\"vpnc-04ubidcy\"]", "item_type": "string" } ], "required": [] }, { "name": "DisassociateAddress", "description": "本接口 (DisassociateAddress) 用于解绑[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)（简称 EIP）。 * 支持CVM实例，弹性网卡上的EIP解绑。 * 不支持NAT上的EIP解绑。NAT上的EIP解绑请参考[DisassociateNatGatewayAddress](https://cloud.tencent.com/document/api/215/36716)。 * 只有状态为 BIND 和 BIND_ENI 的 EIP 才能进行解绑定操作。", "status": "online", "parameters": [ { "name": "AddressId", "type": "string", "required": true, "description": "标识 EIP 的唯一 ID。EIP 唯一 ID 形如：`eip-11112222`。可以使用[DescribeAddresses](https://cloud.tencent.com/document/product/215/16702)接口获取AddressId。", "example": "eip-ek0cdz1g" }, { "name": "ReallocateNormalPublicIp", "type": "boolean", "required": false, "description": "表示解绑 EIP 之后是否分配普通公网 IP。取值范围：TRUE：表示解绑 EIP 之后分配普通公网 IP。FALSE：表示解绑 EIP 之后不分配普通公网 IP。默认取值：FALSE。只有满足以下条件时才能指定该参数：只有在解绑主网卡的主内网 IP 上的 EIP 时才能指定该参数。解绑 EIP 后重新分配普通公网 IP 操作一个账号每天最多操作 10 次；详情可通过 [DescribeAddressQuota](https://cloud.tencent.com/document/api/21...", "example": "True" } ], "required": [ "AddressId" ] }, { "name": "DisassociateDhcpIpWithAddressIp", "description": "本接口（DisassociateDhcpIpWithAddressIp）用于将DhcpIp已绑定的弹性公网IP（EIP）解除绑定。 \u003e?本接口为异步接口，可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果，待任务执行成功后再进行其他操作。 \u003e", "status": "online", "parameters": [ { "name": "DhcpIpId", "type": "string", "required": true, "description": "`DhcpIp`唯一`ID`，形如：`dhcpip-9o233uri`。必须是已绑定`EIP`的`DhcpIp`。", "example": "dhcpip-9o233uri" } ], "required": [ "DhcpIpId" ] }, { "name": "DisassociateDirectConnectGatewayNatGateway", "description": "将专线网关与NAT网关解绑，解绑之后，专线网关将不能通过NAT网关访问公网", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC实例ID。形如：vpc-xxx。", "example": "vpc-8xpno8ee" }, { "name": "NatGatewayId", "type": "string", "required": true, "description": "NAT网关ID。形如：nat-xxx", "example": "nat-ig8xpno8" }, { "name": "DirectConnectGatewayId", "type": "string", "required": true, "description": "专线网关ID。形如：dcg-xxx", "example": "dcg-fxa6gh5t" } ], "required": [ "VpcId", "NatGatewayId", "DirectConnectGatewayId" ] }, { "name": "DisassociateHaVipInstance", "description": "本接口（DisassociateHaVipInstance）用于HAVIP解绑子机或网卡（去掉HaVip飘移范围）。", "status": "online", "parameters": [ { "name": "HaVipAssociationSet", "type": "array", "required": true, "description": "HaVip解绑的子机或网卡。最多支持10个实例。", "example": "[{\"HaVipId\": \"havip-7tqt5jn6\", \"InstanceType\": \"CVM\", \"InstanceId\": \"ins-3qx9elib\"}]", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "HaVip绑定的子机或网卡唯一ID。", "example": "ins-3qx9elib" }, { "name": "HaVipId", "type": "string", "required": false, "description": "HaVip实例唯一ID。", "example": "havip-7tqt5jn6" }, { "name": "InstanceType", "type": "string", "required": false, "description": "HaVip绑定的类型。取值:CVM, ENI。", "example": "CVM" } ] } ], "required": [ "HaVipAssociationSet" ] }, { "name": "DisassociateIPv6Address", "description": "本接口（DisassociateIPv6Address）用于解绑弹性公网 IPv6（简称EIPv6）实例。 - 支持对 CVM、弹性网卡绑定的 EIPv6 实例进行解绑操作。 - 只有状态为 BIND 和 BIND_ENI 的 EIPv6 实例才能进行解绑操作。", "status": "online", "parameters": [ { "name": "IPv6AddressId", "type": "string", "required": true, "description": "弹性公网IPv6唯一ID，EIPv6 唯一 ID 形如：eipv6-11112222。可以使用[DescribeIPv6Addresses](https://cloud.tencent.com/document/api/215/113677)接口获取IPv6AddressId。", "example": "eipv6-nzvwsush" }, { "name": "KeepBindWithEni", "type": "boolean", "required": false, "description": "解绑时是否保持绑定弹性网卡。可选值：true、false。 默认值：false", "example": "false" } ], "required": [ "IPv6AddressId" ] }, { "name": "DisassociateNatGatewayAddress", "description": "本接口（DisassociateNatGatewayAddress）用于NAT网关解绑弹性IP。", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "NAT网关的ID，形如：`nat-df45454`。", "example": "nat-mdbjfr0y" }, { "name": "PublicIpAddresses", "type": "array", "required": true, "description": "待解绑NAT网关的弹性IP数组。", "example": "[\"139.199.232.212\"]", "item_type": "string" } ], "required": [ "NatGatewayId", "PublicIpAddresses" ] }, { "name": "DisassociateNetworkAclSubnets", "description": "本接口（DisassociateNetworkAclSubnets）用于网络ACL解关联VPC下的子网。", "status": "online", "parameters": [ { "name": "NetworkAclId", "type": "string", "required": true, "description": "网络ACL实例ID。例如：acl-12345678。", "example": "acl-12345678" }, { "name": "SubnetIds", "type": "array", "required": true, "description": "子网实例ID数组。例如：[subnet-12345678]。", "example": "[\"subnet-12345678\\n\"]", "item_type": "string" } ], "required": [ "NetworkAclId", "SubnetIds" ] }, { "name": "DisassociateNetworkInterfaceSecurityGroups", "description": "本接口（DisassociateNetworkInterfaceSecurityGroups）用于弹性网卡解绑安全组。支持弹性网卡完全解绑安全组。", "status": "online", "parameters": [ { "name": "NetworkInterfaceIds", "type": "array", "required": true, "description": "弹性网卡实例ID。形如：eni-pxir56ns。每次请求的实例的上限为100。可通过[DescribeNetworkInterfaces](https://cloud.tencent.com/document/product/215/15817)接口获取。", "example": "[\"eni-12345678\"]", "item_type": "string" }, { "name": "SecurityGroupIds", "type": "array", "required": true, "description": "安全组实例ID，例如：sg-33ocnj9n，可通过[DescribeSecurityGroups](https://cloud.tencent.com/document/product/215/15808)接口获取。每次请求的实例的上限为100。", "example": "[\"sg-12345678\"]", "item_type": "string" } ], "required": [ "NetworkInterfaceIds", "SecurityGroupIds" ] }, { "name": "DisassociateVpcEndPointSecurityGroups", "description": "本接口（DisassociateVpcEndPointSecurityGroups）用于终端节点解绑安全组。", "status": "online", "parameters": [ { "name": "SecurityGroupIds", "type": "array", "required": true, "description": "安全组ID数组。可通过[DescribeSecurityGroups](https://cloud.tencent.com/document/product/215/15808)接口获取。", "example": "[\"sg-serghftg\"]", "item_type": "string" }, { "name": "EndPointId", "type": "string", "required": true, "description": "终端节点ID。可通过[DescribeVpcEndPoint](https://cloud.tencent.com/document/product/215/54679) 获取。", "example": "vpce-h0fk8lfc" } ], "required": [ "SecurityGroupIds", "EndPointId" ] }, { "name": "DownloadCustomerGatewayConfiguration", "description": "本接口（DownloadCustomerGatewayConfiguration）用于下载VPN通道配置。", "status": "online", "parameters": [ { "name": "VpnGatewayId", "type": "string", "required": true, "description": "VPN网关实例ID。", "example": "vpngw-p4lmbqwn" }, { "name": "VpnConnectionId", "type": "string", "required": true, "description": "VPN通道实例ID。形如：vpnx-f49l6u0z。", "example": "vpnx-4p6vkch3" }, { "name": "CustomerGatewayVendor", "type": "object", "required": true, "description": "对端网关厂商信息对象，可通过[DescribeCustomerGatewayVendors](https://cloud.tencent.com/document/api/215/17517)获取。", "example": "{ \"Platform\":\"comware\", \"SoftwareVersion\":\"V1.0\", \"VendorName\":\"h3c\" }", "children": [ { "name": "Platform", "type": "string", "required": true, "description": "平台。", "example": "comware" }, { "name": "SoftwareVersion", "type": "string", "required": true, "description": "软件版本。", "example": "V1.0" }, { "name": "VendorName", "type": "string", "required": true, "description": "供应商名称。", "example": "h3c" } ] }, { "name": "InterfaceName", "type": "string", "required": true, "description": "通道接入设备物理接口名称。", "example": "eth0" } ], "required": [ "VpnGatewayId", "VpnConnectionId", "CustomerGatewayVendor", "InterfaceName" ] }, { "name": "DownloadVpnGatewaySslClientCert", "description": "本接口（DownloadVpnGatewaySslClientCert）用于下载SSL-VPN-CLIENT 客户端证书。", "status": "online", "parameters": [ { "name": "SslVpnClientId", "type": "string", "required": false, "description": "SSL-VPN-CLIENT 实例ID。不可以和SslVpnClientIds同时使用。", "example": "vpnc-123456" }, { "name": "SamlToken", "type": "string", "required": false, "description": "SAML Token（SAML令牌）。", "example": "TGYICwnqislmIMHCRgaCumpW8XdgOR3Qz" }, { "name": "IsVpnPortal", "type": "boolean", "required": false, "description": "VPN门户网站使用。默认False", "example": "False" }, { "name": "SslVpnClientIds", "type": "array", "required": false, "description": "SSL-VPN-CLIENT 实例ID列表。批量下载时使用。不可以和SslVpnClientId同时使用。", "example": "[\"vpnc-123456\"]", "item_type": "string" } ], "required": [] }, { "name": "EnableCcnRoutes", "description": "本接口（EnableCcnRoutes）用于启用已经加入云联网（CCN）的路由。 本接口会校验启用后，是否与已有路由冲突，如果冲突，则无法启用，失败处理。路由冲突时，需要先禁用与之冲突的路由，才能启用该路由。", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "CCN实例ID。形如：ccn-f49l6u0z。", "example": "ccn-gree226l" }, { "name": "RouteIds", "type": "array", "required": true, "description": "CCN路由策略唯一ID。形如：ccnr-f49l6u0z。可通过DescribeCcnRoutes接口获取。", "example": "[\"ccnr-bvipc87w\\r\\n\"]", "item_type": "string" } ], "required": [ "CcnId", "RouteIds" ] }, { "name": "EnableFlowLogs", "description": "本接口（EnableFlowLogs）用于启动流日志。", "status": "online", "parameters": [ { "name": "FlowLogIds", "type": "array", "required": true, "description": "流日志Id。可通过[CreateFlowLog](https://cloud.tencent.com/document/product/215/35015)接口创建；可通过[DescribeFlowLogs](https://cloud.tencent.com/document/product/215/35012)接口获取。", "example": "[\"fl-7rymh5cn\"]", "item_type": "string" } ], "required": [ "FlowLogIds" ] }, { "name": "EnableGatewayFlowMonitor", "description": "本接口（EnableGatewayFlowMonitor）用于开启网关流量监控。", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关实例ID，目前我们支持的网关实例有， 专线网关实例ID，形如，`dcg-ltjahce6`； Nat网关实例ID，形如，`nat-ltjahce6`； VPN网关实例ID，形如，`vpn-ltjahce6`。", "example": "vpngw-gree226l" } ], "required": [ "GatewayId" ] }, { "name": "EnableRoutes", "description": "本接口（EnableRoutes）用于启用已禁用的子网路由。 本接口会校验启用后，是否与已有路由冲突，如果冲突，则无法启用，失败处理。路由冲突时，需要先禁用与之冲突的路由，才能启用该路由。", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表唯一ID。", "example": "rtb-9wzwlnhc" }, { "name": "RouteIds", "type": "array", "required": false, "description": "路由策略ID。不能和RouteItemIds同时使用，但至少输入一个。单次处理上限100个。该参数取值可通过查询路由列表（[DescribeRouteTables](https://cloud.tencent.com/document/product/215/15763)）获取。", "example": "[\"18292\\n\",\"18293\\n\"]", "item_type": "integer" }, { "name": "RouteItemIds", "type": "array", "required": false, "description": "路由策略唯一ID。不能和RouteIds同时使用，但至少输入一个。单次处理上限100个。该参数取值可通过查询路由列表（[DescribeRouteTables](https://cloud.tencent.com/document/product/215/15763)）获取。", "example": "[\"18293\"]", "item_type": "string" } ], "required": [ "RouteTableId" ] }, { "name": "EnableSnapshotPolicies", "description": "本接口（EnableSnapshotPolicies）用于启用快照策略。", "status": "online", "parameters": [ { "name": "SnapshotPolicyIds", "type": "array", "required": true, "description": "快照策略Id。", "example": "[\"sspolicy-g6jwvm35\"]", "item_type": "string" } ], "required": [ "SnapshotPolicyIds" ] }, { "name": "EnableVpcEndPointConnect", "description": "本接口（EnableVpcEndPointConnect）用于是否接受终端节点连接请求。", "status": "online", "parameters": [ { "name": "EndPointServiceId", "type": "string", "required": true, "description": "终端节点服务ID。可通过[DescribeVpcEndPointService](https://cloud.tencent.com/document/product/215/54678)接口获取。", "example": "vpcsvc-8gdaqxi0" }, { "name": "EndPointId", "type": "array", "required": true, "description": "终端节点ID。可通过[DescribeVpcEndPoint](https://cloud.tencent.com/document/product/215/54679) 获取。", "example": "[\"vpce-8gdaqxi0\"]", "item_type": "string" }, { "name": "AcceptFlag", "type": "boolean", "required": true, "description": "是否接受终端节点连接请求。 true：自动接受。 false：不自动接受。", "example": "True" }, { "name": "IpAddressType", "type": "string", "required": false, "description": "协议类型，支持 Ipv4，Ipv6，默认 Ipv4。", "example": "Ipv4" } ], "required": [ "EndPointServiceId", "EndPointId", "AcceptFlag" ] }, { "name": "EnableVpnGatewaySslClientCert", "description": "本接口（EnableVpnGatewaySslClientCert）用于启用SSL-VPN-CLIENT 证书。", "status": "online", "parameters": [ { "name": "SslVpnClientId", "type": "string", "required": false, "description": "SSL-VPN-CLIENT 实例ID。不可和SslVpnClientIds同时使用。", "example": "vpnc-123456" }, { "name": "SslVpnClientIds", "type": "array", "required": false, "description": "SSL-VPN-CLIENT 实例ID列表。批量启用时使用。不可和SslVpnClientId同时使用。", "example": "[\"vpnc-123456\"]", "item_type": "string" } ], "required": [] }, { "name": "GenerateVpnConnectionDefaultHealthCheckIp", "description": "本接口（GenerateVpnConnectionDefaultHealthCheckIp）用于获取一对VPN通道健康检查地址。", "status": "online", "parameters": [ { "name": "VpnGatewayId", "type": "string", "required": true, "description": "VPN网关id， 例如：vpngw-1w9tue3d", "example": "vpngw-1w9tue3d" } ], "required": [ "VpnGatewayId" ] }, { "name": "GetCcnRegionBandwidthLimits", "description": "本接口（GetCcnRegionBandwidthLimits）用于查询云联网相关地域带宽信息，其中预付费模式的云联网仅支持地域间限速，后付费模式的云联网支持地域间限速和地域出口限速。", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "CCN实例ID。形如：ccn-f49l6u0z。", "example": "ccn-xxxxxxxx" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 sregion - String - （过滤条件）源地域，形如：ap-guangzhou。 dregion - String - （过滤条件）目的地域，形如：ap-shanghai-bm", "example": "[{\"Name\":\"sregion\",\"Values\":[\"ap-guangzhou\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "属性名称, 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。", "example": "tag-key" }, { "name": "Values", "type": "array", "required": true, "description": "属性值, 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。当值类型为布尔类型时，可直接取值为字符串\"TRUE\"或 \"FALSE\"。", "example": "[\"TagKeyA\", \"TagKeyB\"]", "item_type": "string" } ] }, { "name": "SortedBy", "type": "string", "required": false, "description": "排序条件，目前支持带宽（`BandwidthLimit`）和过期时间（`ExpireTime`），默认按 `ExpireTime` 排序。", "example": "ExpireTime" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量。", "example": "10" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序方式，'ASC':升序,'DESC':降序。默认按'ASC'排序。", "example": "ASC" } ], "required": [ "CcnId" ] }, { "name": "HaVipAssociateAddressIp", "description": "本接口（HaVipAssociateAddressIp）用于高可用虚拟IP（HAVIP）绑定弹性公网IP（EIP）。 本接口是异步完成，如需查询异步任务执行结果，请使用本接口返回的`RequestId`轮询`DescribeVpcTaskResult`接口。", "status": "online", "parameters": [ { "name": "HaVipId", "type": "string", "required": true, "description": "`HAVIP`唯一`ID`，形如：`havip-9o233uri`。必须是没有绑定`EIP`的`HAVIP`。", "example": "havip-9o233uri" }, { "name": "AddressIp", "type": "string", "required": true, "description": "弹性公网`IP`。必须是没有绑定`HAVIP`的`EIP`。", "example": "119.29.93.218" } ], "required": [ "HaVipId", "AddressIp" ] }, { "name": "HaVipDisassociateAddressIp", "description": "本接口（HaVipDisassociateAddressIp）用于将高可用虚拟IP（HAVIP）已绑定的弹性公网IP（EIP）解除绑定。 本接口是异步完成，如需查询异步任务执行结果，请使用本接口返回的`RequestId`轮询`DescribeVpcTaskResult`接口。", "status": "online", "parameters": [ { "name": "HaVipId", "type": "string", "required": true, "description": "`HAVIP`唯一`ID`，形如：`havip-9o233uri`。必须是已绑定`EIP`的`HAVIP`。", "example": "havip-9o233uri" } ], "required": [ "HaVipId" ] }, { "name": "InquirePriceCreateDirectConnectGateway", "description": "本接口（DescribePriceCreateDirectConnectGateway）用于创建专线网关询价。", "status": "online", "parameters": [], "required": [] }, { "name": "InquiryPriceAllocateAddresses", "description": "本接口（InquiryPriceAllocateAddresses）用于新购弹性公网IP询价。", "status": "online", "parameters": [ { "name": "InternetChargeType", "type": "string", "required": true, "description": "EIP计费方式。 账号为标准账户类型的用户，可选值： BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费 BANDWIDTH_PREPAID_BY_MONTH：包月按带宽预付费 TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费", "example": "TRAFFIC_POSTPAID_BY_HOUR" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "EIP出带宽上限，单位：Mbps。 账号为标准账户类型的用户，可选值范围取决于EIP计费方式： BANDWIDTH_POSTPAID_BY_HOUR：1 Mbps 至 100 Mbps BANDWIDTH_PREPAID_BY_MONTH：1 Mbps 至 200 Mbps TRAFFIC_POSTPAID_BY_HOUR：1 Mbps 至 100 Mbps默认值：1 Mbps。 账号为传统账户类型的用户，EIP出带宽上限取决于与其绑定的实例的公网出带宽上限，无需传递此参数。", "example": "1" }, { "name": "AddressChargePrepaid", "type": "object", "required": false, "description": "包月按带宽预付费EIP的计费参数。EIP为包月按带宽预付费时，该参数必传，其余场景不需传递", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位是月。可支持时长：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36", "example": "12" }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "自动续费标志。0表示手动续费，1表示自动续费，2表示到期不续费。默认缺省为1即自动续费。", "example": "2" } ] }, { "name": "AddressType", "type": "string", "required": false, "description": "EIP类型。默认值：EIP。 弹性公网IP，可选值：EIP：弹性公网IP 精品IP，可选值：HighQualityEIP：精品IP注意：仅新加坡和中国香港支持精品IP。 高防IP，可选值：AntiDDoSEIP：高防IP注意：仅部分地域支持高防IP，详情可见弹性公网IP[产品概述](https://cloud.tencent.com/document/product/1199/41646)。", "example": "EIP" }, { "name": "IPChargeType", "type": "string", "required": false, "description": "原生EIP IP资源的计费方式。 账号为标准账户类型的用户，可选值： IP_POSTPAID_BY_HOUR：IP资源按小时后付费 IP_PREPAID_BY_MONTH：IP资源包月预付费", "example": "IP_POSTPAID_BY_HOUR" } ], "required": [ "InternetChargeType" ] }, { "name": "InquiryPriceCreateVpnGateway", "description": "本接口（InquiryPriceCreateVpnGateway）用于创建VPN网关询价。", "status": "online", "parameters": [ { "name": "InternetMaxBandwidthOut", "type": "integer", "required": true, "description": "公网带宽设置。可选带宽规格：5, 10, 20, 50, 100, 200, 500, 1000, 3000；单位：Mbps。", "example": "5" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "VPN网关计费模式，PREPAID：表示预付费，即包年包月，POSTPAID_BY_HOUR：表示后付费，即按量计费。默认：POSTPAID_BY_HOUR，如果指定预付费模式，参数InstanceChargePrepaid必填。", "example": "PREPAID" }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。", "example": "{'Period':1, 'RenewFlag': 'NOTIFY_AND_AUTO_RENEW'}", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费， NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费。默认：NOTIFY_AND_AUTO_RENEW", "example": "NOTIFY_AND_AUTO_RENEW" } ] }, { "name": "MaxConnection", "type": "integer", "required": false, "description": "SSL VPN连接数设置，可选规格：5, 10, 20, 50, 100, 200, 500, 1000；单位：个。", "example": "5" }, { "name": "Type", "type": "string", "required": false, "description": "查询的VPN类型，支持IPSEC、SSL两种类型，为SSL类型时，MaxConnection参数必传。", "example": "IPSEC" } ], "required": [ "InternetMaxBandwidthOut" ] }, { "name": "InquiryPriceModifyAddressesBandwidth", "description": "本接口（InquiryPriceModifyAddressesBandwidth）用于EIP修改带宽询价。", "status": "online", "parameters": [ { "name": "AddressIds", "type": "array", "required": true, "description": "EIP唯一ID，可以使用[DescribeAddresses](https://cloud.tencent.com/document/product/215/16702)接口获取AddressId。", "example": "eip-e7yggyi0", "item_type": "string" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": true, "description": "新带宽值，可调整的带宽上限值参考产品文档[带宽上限](https://cloud.tencent.com/document/product/1199/48333)。", "example": "1" } ], "required": [ "AddressIds", "InternetMaxBandwidthOut" ] }, { "name": "InquiryPriceRenewAddresses", "description": "本接口（InquiryPriceRenewAddresses）用于续费预付费弹性公网IP询价，只支持包月按带宽预付费的计费模式。", "status": "online", "parameters": [ { "name": "AddressIds", "type": "array", "required": true, "description": "续费资源实例ID。可以使用[DescribeAddresses](https://cloud.tencent.com/document/product/215/16702)接口获取AddressId。", "example": "eip-test1234", "item_type": "string" }, { "name": "AddressChargePrepaid", "type": "object", "required": true, "description": "包月按带宽预付费EIP的计费参数。EIP为包月按带宽预付费时，该参数必传，不支持其他计费模式。", "example": "12", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位是月。可支持时长：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36", "example": "12" }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "自动续费标志。0表示手动续费，1表示自动续费，2表示到期不续费。默认缺省为1即自动续费。", "example": "2" } ] } ], "required": [ "AddressIds", "AddressChargePrepaid" ] }, { "name": "InquiryPriceRenewVpnGateway", "description": "本接口（InquiryPriceRenewVpnGateway）用于续费VPN网关询价。目前仅支持IPSEC类型网关的询价。", "status": "online", "parameters": [ { "name": "VpnGatewayId", "type": "string", "required": true, "description": "VPN网关实例ID。", "example": "vpngw-ac13cgez" }, { "name": "InstanceChargePrepaid", "type": "object", "required": true, "description": "预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。", "example": "{'Period': 36}", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费， NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费。默认：NOTIFY_AND_AUTO_RENEW", "example": "NOTIFY_AND_AUTO_RENEW" } ] } ], "required": [ "VpnGatewayId", "InstanceChargePrepaid" ] }, { "name": "InquiryPriceResetVpnGatewayInternetMaxBandwidth", "description": "本接口（InquiryPriceResetVpnGatewayInternetMaxBandwidth）用于调整VPN网关带宽上限询价。", "status": "online", "parameters": [ { "name": "VpnGatewayId", "type": "string", "required": true, "description": "VPN网关实例ID。", "example": "vpngw-kjllekna" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": true, "description": "公网带宽设置。可选带宽规格：5, 10, 20, 50, 100, 200, 500, 1000；单位：Mbps。", "example": "10" } ], "required": [ "VpnGatewayId", "InternetMaxBandwidthOut" ] }, { "name": "LockCcnBandwidths", "description": "本接口（LockCcnBandwidths）用户锁定云联网限速实例。 该接口一般用来封禁地域间限速的云联网实例下的限速实例, 目前联通内部运营系统通过云API调用, 如果是出口限速, 一般使用更粗的云联网实例粒度封禁（LockCcns）。 如有需要, 可以封禁任意限速实例, 可接入到内部运营系统。", "status": "online", "parameters": [ { "name": "Instances", "type": "array", "required": true, "description": "带宽实例的唯一ID数组。", "example": "{ 'CcnId': 'ccn-xxxxxxxx', 'RegionFlowControlId': 'fcr-xxxxxxxx', 'UserAccountID': 'xxxxxxxxxx' }", "item_type": "object", "children": [ { "name": "CcnId", "type": "string", "required": true, "description": "带宽所属的云联网ID。", "example": "ccn-2caehl6h" }, { "name": "UserAccountID", "type": "string", "required": true, "description": "实例所属用户主账号ID。", "example": "201111300001" }, { "name": "RegionFlowControlId", "type": "string", "required": false, "description": "带宽实例的唯一ID。作为`UnlockCcnBandwidths`接口和`LockCcnBandwidths`接口的入参时，该字段必传。", "example": "fcr-ceah9fdm" } ] } ], "required": [ "Instances" ] }, { "name": "LockCcns", "description": "本接口（LockCcns）用于锁定云联网实例 该接口一般用来封禁出口限速的云联网实例, 目前联通内部运营系统通过云API调用, 因为出口限速无法按地域间封禁, 只能按更粗的云联网实例粒度封禁, 如果是地域间限速, 一般可以通过更细的限速实例粒度封禁（LockCcnBandwidths） 如有需要, 可以封禁任意限速实例, 可接入到内部运营系统", "status": "online", "parameters": [], "required": [] }, { "name": "MigrateBandwidthPackageResources", "description": "本接口 (MigrateBandwidthPackageResources) 用于共享带宽包之间迁移资源", "status": "online", "parameters": [ { "name": "BandwidthPackageId", "type": "string", "required": true, "description": "当前资源所在的共享带宽包ID", "example": "bwp-hxlqja90" }, { "name": "TargetBandwidthPackageId", "type": "string", "required": true, "description": "要迁移的目标共享带宽包的ID", "example": "bwp-hxlqja90" }, { "name": "ResourceIds", "type": "array", "required": true, "description": "要迁移的资源的ID列表", "example": "[\"eip-hxlqja90\",\"eip-hxlqja91\"]", "item_type": "string" } ], "required": [ "BandwidthPackageId", "TargetBandwidthPackageId", "ResourceIds" ] }, { "name": "MigrateNetworkInterface", "description": "本接口（MigrateNetworkInterface）用于弹性网卡迁移。 本接口是异步完成，如需查询异步任务执行结果，请使用本接口返回的`RequestId`轮询[DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) `接口。", "status": "online", "parameters": [ { "name": "NetworkInterfaceId", "type": "string", "required": true, "description": "弹性网卡实例ID，例如：eni-m6dyj72l。可通过[DescribeNetworkInterfaces](https://cloud.tencent.com/document/product/215/15817)接口获取。", "example": "eni-m6dyj72l" }, { "name": "SourceInstanceId", "type": "string", "required": true, "description": "弹性网卡当前绑定的CVM实例ID。形如：ins-r8hr2upy。可通过[DescribeInstances](https://cloud.tencent.com/document/product/213/15728)接口获取。", "example": "ins-r8hr2upy" }, { "name": "DestinationInstanceId", "type": "string", "required": true, "description": "待迁移的目的CVM实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/product/213/15728)接口获取。", "example": "ins-7qs3ou6z" }, { "name": "AttachType", "type": "integer", "required": false, "description": "网卡绑定类型：0 标准型 1 扩展型。默认：0。", "example": "0" } ], "required": [ "NetworkInterfaceId", "SourceInstanceId", "DestinationInstanceId" ] }, { "name": "MigratePrivateIpAddress", "description": "本接口（MigratePrivateIpAddress）用于弹性网卡内网IP迁移。 * 该接口用于将一个内网IP从一个弹性网卡上迁移到另外一个弹性网卡，主IP地址不支持迁移。 * 迁移前后的弹性网卡必须在同一个子网内。 本接口是异步完成，如需查询异步任务执行结果，请使用本接口返回的`RequestId`轮询[DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口。", "status": "online", "parameters": [ { "name": "SourceNetworkInterfaceId", "type": "string", "required": true, "description": "当内网IP绑定的弹性网卡实例ID，例如：eni-m6dyj72l。可通过[DescribeNetworkInterfaces](https://cloud.tencent.com/document/product/215/15817)接口获取。", "example": "eni-m6dyj722" }, { "name": "DestinationNetworkInterfaceId", "type": "string", "required": true, "description": "待迁移的目的弹性网卡实例ID。可通过[DescribeNetworkInterfaces](https://cloud.tencent.com/document/product/215/15817)接口获取。", "example": "eni-m6dyj72l" }, { "name": "PrivateIpAddress", "type": "string", "required": true, "description": "迁移的内网IP地址，例如：10.0.0.6。", "example": "10.0.0.6" } ], "required": [ "SourceNetworkInterfaceId", "DestinationNetworkInterfaceId", "PrivateIpAddress" ] }, { "name": "ModifyAddressAttribute", "description": "本接口 (ModifyAddressAttribute) 用于修改[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)（简称 EIP）的名称。", "status": "online", "parameters": [ { "name": "AddressId", "type": "string", "required": true, "description": "标识 EIP 的唯一 ID。EIP 唯一 ID 形如：`eip-11112222`。可以使用[DescribeAddresses](https://cloud.tencent.com/document/product/215/16702)接口获取AddressId。", "example": "eip-p2x6wxc0" }, { "name": "AddressName", "type": "string", "required": false, "description": "修改后的 EIP 名称。长度上限为128个字符，允许使用大小写字母、汉字、数字、连字符\"-\"和下划线\"\\_\"，不能包含空格。", "example": "test_eip" }, { "name": "EipDirectConnection", "type": "string", "required": false, "description": "设定EIP是否直通，\"TRUE\"表示直通，\"FALSE\"表示非直通。 注意：该参数仅对 EIP 直通功能可见的用户可以设定，EIP 必须为绑定状态，绑定的对象为 CVM 。", "example": "FALSE" } ], "required": [ "AddressId" ] }, { "name": "ModifyAddressInternetChargeType", "description": "该接口用于调整具有带宽属性弹性公网IP的网络计费模式 * 支持BANDWIDTH_PREPAID_BY_MONTH（包月按带宽预付费）和TRAFFIC_POSTPAID_BY_HOUR（流量按小时后付费）两种网络计费模式之间的切换。 * 每个弹性公网IP支持调整两次，次数超出则无法调整。", "status": "online", "parameters": [ { "name": "AddressId", "type": "string", "required": true, "description": "弹性公网IP的唯一ID，形如eip-xxx，可以使用[DescribeAddresses](https://cloud.tencent.com/document/product/215/16702)接口获取AddressId。", "example": "eip-fo00aojo" }, { "name": "InternetChargeType", "type": "string", "required": true, "description": "弹性公网IP调整目标计费模式，支持： BANDWIDTH_PREPAID_BY_MONTH：包月按带宽预付费 TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费 BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费", "example": "TRAFFIC_POSTPAID_BY_HOUR" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": true, "description": "弹性公网IP调整目标带宽值，可调整的带宽上限值参考产品文档[带宽上限](https://cloud.tencent.com/document/product/1199/48333)。", "example": "5" }, { "name": "AddressChargePrepaid", "type": "object", "required": false, "description": "包月带宽网络计费模式参数。弹性公网IP的调整目标计费模式是 BANDWIDTH_PREPAID_BY_MONTH（包月按带宽预付费）时，必传该参数。", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位是月。可支持时长：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36", "example": "12" }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "自动续费标志。0表示手动续费，1表示自动续费，2表示到期不续费。默认缺省为1即自动续费。", "example": "2" } ] } ], "required": [ "AddressId", "InternetChargeType", "InternetMaxBandwidthOut" ] }, { "name": "ModifyAddressTemplateAttribute", "description": "本接口（ModifyAddressTemplateAttribute）用于修改IP地址模板。 \u003e?本接口为异步接口，可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果，待任务执行成功后再进行其他操作。 \u003e", "status": "online", "parameters": [ { "name": "AddressTemplateId", "type": "string", "required": true, "description": "IP地址模板实例ID，例如：ipm-mdunqeb6。", "example": "ipm-mdunqeb6" }, { "name": "AddressTemplateName", "type": "string", "required": false, "description": "IP地址模板名称。", "example": "demo" }, { "name": "Addresses", "type": "array", "required": false, "description": "地址信息，支持 IP、CIDR、IP 范围。", "example": "[\"10.0.0.10\"]", "item_type": "string" }, { "name": "AddressesExtra", "type": "array", "required": false, "description": "支持添加备注的地址信息，支持 IP、CIDR、IP 范围。", "example": "[{\"Address\": \"10.0.0.10\", \"Description\": \"demo\"}]", "item_type": "object", "children": [ { "name": "Address", "type": "string", "required": true, "description": "ip地址。", "example": "2.2.2.2" }, { "name": "Description", "type": "string", "required": false, "description": "备注。", "example": "desc" }, { "name": "UpdatedTime", "type": "string", "required": false, "description": "更新时间。", "example": "2020-08-10 18:10:12" } ] } ], "required": [ "AddressTemplateId" ] }, { "name": "ModifyAddressTemplateGroupAttribute", "description": "本接口（ModifyAddressTemplateGroupAttribute）用于修改IP地址模板集合。 \u003e?本接口为异步接口，可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果，待任务执行成功后再进行其他操作。 \u003e", "status": "online", "parameters": [ { "name": "AddressTemplateGroupId", "type": "string", "required": true, "description": "IP地址模板集合实例ID，例如：ipmg-2uw6ujo6。", "example": "ipmg-2uw6ujo6" }, { "name": "AddressTemplateGroupName", "type": "string", "required": false, "description": "IP地址模板集合名称。", "example": "demo" }, { "name": "AddressTemplateIds", "type": "array", "required": false, "description": "IP地址模板实例ID， 例如：ipm-mdunqeb6。", "example": "[\"ipm-mdunqeb6\"]", "item_type": "string" } ], "required": [ "AddressTemplateGroupId" ] }, { "name": "ModifyAddressesBandwidth", "description": "本接口（ModifyAddressesBandwidth）用于调整[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)(简称EIP)带宽，支持后付费EIP, 预付费EIP和带宽包EIP", "status": "online", "parameters": [ { "name": "AddressIds", "type": "array", "required": true, "description": "EIP唯一标识ID列表，形如'eip-xxxx'，可以使用[DescribeAddresses](https://cloud.tencent.com/document/product/215/16702)接口获取AddressId。", "example": "[\"eip-alfxy9c8\"]", "item_type": "string" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": true, "description": "调整带宽目标值，可调整的带宽上限值参考产品文档[带宽上限](https://cloud.tencent.com/document/product/1199/48333)。", "example": "2" } ], "required": [ "AddressIds", "InternetMaxBandwidthOut" ] }, { "name": "ModifyAddressesRenewFlag", "description": "本接口（ModifyAddressesRenewFlag）用于调整EIP续费标识。", "status": "online", "parameters": [ { "name": "AddressIds", "type": "array", "required": true, "description": "EIP唯一标识ID列表，形如'eip-xxxx'，可以使用[DescribeAddresses](https://cloud.tencent.com/document/product/215/16702)接口获取AddressId。", "example": "[\"eip-alfxy9c8\"]", "item_type": "string" }, { "name": "RenewFlag", "type": "string", "required": true, "description": "自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费 若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。 示例值：NOTIFY_AND_AUTO_RENEW", "example": "NOTIFY_AND_AUTO_RENEW" } ], "required": [ "AddressIds", "RenewFlag" ] }, { "name": "ModifyAssistantCidr", "description": "本接口（ModifyAssistantCidr）用于批量修改辅助CIDR，支持新增和删除。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "`VPC`实例`ID`。形如：`vpc-6v2ht8q5`。", "example": "vpc-nswq8wkq" }, { "name": "NewCidrBlocks", "type": "array", "required": false, "description": "待添加的辅助CIDR。CIDR数组，格式如[\"10.0.0.0/16\", \"172.16.0.0/16\"]，入参NewCidrBlocks和OldCidrBlocks至少需要其一。", "example": "[\"172.16.1.0/24\"]", "item_type": "string" }, { "name": "OldCidrBlocks", "type": "array", "required": false, "description": "待删除的辅助CIDR。CIDR数组，格式如[\"10.0.0.0/16\", \"172.16.0.0/16\"]，入参NewCidrBlocks和OldCidrBlocks至少需要其一。", "example": "[\"172.16.0.0/24\"]", "item_type": "string" } ], "required": [ "VpcId" ] }, { "name": "ModifyBandwidthPackageAttribute", "description": "接口用于修改带宽包属性，包括带宽包名称和计费模式", "status": "online", "parameters": [ { "name": "BandwidthPackageId", "type": "string", "required": true, "description": "带宽包唯一标识ID", "example": "bwp-e40edw8y" }, { "name": "BandwidthPackageName", "type": "string", "required": true, "description": "带宽包名称", "example": "demo" }, { "name": "ChargeType", "type": "string", "required": false, "description": "带宽包计费模式，可选值: ENHANCED95_POSTPAID_BY_MONTH: 后付费-增强型95计费 PRIMARY_TRAFFIC_POSTPAID_BY_HOUR: 后付费-按主流量计费 BANDWIDTH_POSTPAID_BY_DAY: 常规BGP-后付费-按带宽计费 FIXED_PREPAID_BY_MONTH: 常规BGP-预付费 PEAK_BANDWIDTH_POSTPAID_BY_DAY: 静态单线-后付费-按日结算 TOP5_POSTPAID_BY_MONTH: 后付费-TOP5计费，如需使用，请提交工单申请", "example": "TOP5_POSTPAID_BY_MONTH" } ], "required": [ "BandwidthPackageId", "BandwidthPackageName" ] }, { "name": "ModifyBandwidthPackageBandwidth", "description": "接口用于调整[共享带宽包](https://cloud.tencent.com/document/product/684/15245)(BWP)带宽", "status": "online", "parameters": [ { "name": "InternetMaxBandwidth", "type": "integer", "required": true, "description": "带宽包限速大小。单位：Mbps。带宽包计费类型对应的带宽上下限可参考：[BandwidthRange](https://cloud.tencent.com/document/api/215/15824#BandwidthRange)", "example": "100" }, { "name": "BandwidthPackageId", "type": "string", "required": true, "description": "共享带宽包ID，可以使用[DescribeBandwidthPackages](https://cloud.tencent.com/document/product/215/19209)接口查询BandwidthPackageId。", "example": "bwp-mwoqajk2" } ], "required": [ "InternetMaxBandwidth", "BandwidthPackageId" ] }, { "name": "ModifyCcnAttachedInstancesAttribute", "description": "修改CCN关联实例属性，目前仅修改备注description", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "CCN实例ID。形如：ccn-f49l6u0z。", "example": "ccn-gree226l" }, { "name": "Instances", "type": "array", "required": true, "description": "关联网络实例列表", "example": "无", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "关联实例ID。", "example": "vpc-lt6ork07" }, { "name": "InstanceRegion", "type": "string", "required": true, "description": "关联实例ID所属大区，例如：ap-guangzhou。", "example": "ap-guangzhou" }, { "name": "InstanceType", "type": "string", "required": true, "description": "关联实例类型，可选值： `VPC`：私有网络 `DIRECTCONNECT`：专线网关 `BMVPC`：黑石私有网络 `VPNGW`：VPNGW类型", "example": "VPC" }, { "name": "Description", "type": "string", "required": false, "description": "备注", "example": "remark" }, { "name": "RouteTableId", "type": "string", "required": false, "description": "实例关联的路由表ID。", "example": "ccnrtb-1234edfr" }, { "name": "OrderType", "type": "string", "required": false, "description": "实例付费方式", "example": "PayByCcnOwner" } ] } ], "required": [ "CcnId", "Instances" ] }, { "name": "ModifyCcnAttribute", "description": "本接口（ModifyCcnAttribute）用于修改云联网（CCN）的相关属性。", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "CCN实例ID。形如：ccn-f49l6u0z。", "example": "ccn-gjug0kul" }, { "name": "CcnName", "type": "string", "required": false, "description": "CCN名称，最大长度不能超过60个字节，限制：CcnName和CcnDescription必须至少选择一个参数输入，否则报错。", "example": "new+name" }, { "name": "CcnDescription", "type": "string", "required": false, "description": "CCN描述信息，最大长度不能超过100个字节，限制：CcnName和CcnDescription必须至少选择一个参数输入，否则报错。", "example": "desc" }, { "name": "RouteECMPFlag", "type": "boolean", "required": false, "description": "是否开启等价路由功能。`False` 不开启，`True` 开启。", "example": "true" }, { "name": "RouteOverlapFlag", "type": "boolean", "required": false, "description": "是否开启路由重叠功能。`False` 不开启，`True` 开启。", "example": "true" }, { "name": "TrafficMarkingPolicyFlag", "type": "boolean", "required": false, "description": "是否开启qos功能。`False` 不开启，`True` 开启。", "example": "true" } ], "required": [ "CcnId" ] }, { "name": "ModifyCcnPolicyBasedRoutingNextHopAttribute", "description": "更新云联网策略路由下一跳参数", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "云联网ID", "example": "ccn-7bw2xi31" }, { "name": "PolicyBasedRoutingNextHopId", "type": "string", "required": true, "description": "策略路由下一跳ID", "example": "pbrnh-bbjdqarl" }, { "name": "Name", "type": "string", "required": false, "description": "名称", "example": "next hop" }, { "name": "Description", "type": "string", "required": false, "description": "描述", "example": "next hop" }, { "name": "NextHopRegion", "type": "string", "required": false, "description": "下一跳地域", "example": "ap-guangzhou" }, { "name": "InstanceType", "type": "string", "required": false, "description": "实例类型[VPC,DIRECTCONNECT,VPNGW]", "example": "VPC" }, { "name": "InstanceId", "type": "string", "required": false, "description": "关联实例ID", "example": "vpc-6zgq4gsp" }, { "name": "NextHopResourceType", "type": "string", "required": false, "description": "下一跳资源类型[HAVIP,GWLB_ENDPOINT]", "example": "HAVIP" }, { "name": "NextHopResourceId", "type": "string", "required": false, "description": "下一跳资源ID", "example": "havip-lmojafue" }, { "name": "State", "type": "string", "required": false, "description": "状态", "example": "DISABLE" } ], "required": [ "CcnId", "PolicyBasedRoutingNextHopId" ] }, { "name": "ModifyCcnPolicyBasedRoutingRuleAttribute", "description": "更新云联网策略路由匹配规则参数", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "云联网ID", "example": "ccn-7bw2xi31" }, { "name": "PolicyBasedRoutingRuleId", "type": "string", "required": true, "description": "策略路由匹配规则ID", "example": "pbrrule-n6anb2js" }, { "name": "Description", "type": "string", "required": false, "description": "描述", "example": "rule" } ], "required": [ "CcnId", "PolicyBasedRoutingRuleId" ] }, { "name": "ModifyCcnRegionBandwidthLimitsType", "description": "本接口（ModifyCcnRegionBandwidthLimitsType）用于修改后付费云联网实例修改带宽限速策略。", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "云联网实例ID。", "example": "ccn-gree226l" }, { "name": "BandwidthLimitType", "type": "string", "required": false, "description": "云联网限速类型，INTER_REGION_LIMIT：地域间限速，OUTER_REGION_LIMIT：地域出口限速。默认值：OUTER_REGION_LIMIT。", "example": "OUTER_REGION_LIMIT" } ], "required": [ "CcnId" ] }, { "name": "ModifyCcnRouteTables", "description": "该接口用于修改云联网路由表名称和备注。", "status": "online", "parameters": [ { "name": "RouteTableInfo", "type": "array", "required": true, "description": "需要修改的路由表列表。", "example": "{ 'RouteTableId': 'ccnr-xxxxxxxx', 'Name': 'name', 'Description': 'desc' }", "item_type": "object", "children": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "云联网路由表id。", "example": "ccnrtb-245ecr35" }, { "name": "Name", "type": "string", "required": false, "description": "云联网路由表名称。Name和Description 两者必传一个。", "example": "rtb-name" }, { "name": "Description", "type": "string", "required": false, "description": "云联网路由表描述。Name和Description 两者必传一个。", "example": "rtb-desc" } ] } ], "required": [ "RouteTableInfo" ] }, { "name": "ModifyCdcLDCXAttribute", "description": "修改 IDC通道信息", "status": "online", "parameters": [], "required": [] }, { "name": "ModifyCdcNetPlaneAttribute", "description": "修改虚拟连接", "status": "online", "parameters": [], "required": [] }, { "name": "ModifyCustomerGatewayAttribute", "description": "本接口（ModifyCustomerGatewayAttribute）用于修改对端网关信息。", "status": "online", "parameters": [ { "name": "CustomerGatewayId", "type": "string", "required": true, "description": "对端网关ID，例如：cgw-2wqq41m9，可通过[DescribeCustomerGateways](https://cloud.tencent.com/document/api/215/17516)接口查询对端网关。", "example": "cgw-mgp33pll" }, { "name": "CustomerGatewayName", "type": "string", "required": true, "description": "对端网关名称，可任意命名，但不得超过60个字符。", "example": "NewName" }, { "name": "BgpAsn", "type": "integer", "required": false, "description": "BGP ASN。只有开启BGP白名单才可以修改此参数。", "example": "2" } ], "required": [ "CustomerGatewayId", "CustomerGatewayName" ] }, { "name": "ModifyDhcpIpAttribute", "description": "本接口（ModifyDhcpIpAttribute）用于修改DhcpIp属性", "status": "online", "parameters": [ { "name": "DhcpIpId", "type": "string", "required": true, "description": "`DhcpIp`唯一`ID`，形如：`dhcpip-9o233uri`。", "example": "dhcpip-9o233uri" }, { "name": "DhcpIpName", "type": "string", "required": true, "description": "`DhcpIp`名称，可任意命名，但不得超过60个字符。", "example": "new name" } ], "required": [ "DhcpIpId", "DhcpIpName" ] }, { "name": "ModifyDirectConnectGatewayAttribute", "description": "本接口（ModifyDirectConnectGatewayAttribute）用于修改专线网关属性", "status": "online", "parameters": [ { "name": "DirectConnectGatewayId", "type": "string", "required": true, "description": "专线网关唯一`ID`，形如：`dcg-9o233uri`。", "example": "dcg-k6cswwhx" }, { "name": "DirectConnectGatewayName", "type": "string", "required": false, "description": "专线网关名称，可任意命名，但不得超过60个字符。", "example": "new+name" }, { "name": "CcnRouteType", "type": "string", "required": false, "description": "云联网路由学习类型，可选值：`BGP`（自动学习）、`STATIC`（静态，即用户配置）。只有云联网类型专线网关且开启了BGP功能才支持修改`CcnRouteType`。", "example": "BGP" }, { "name": "ModeType", "type": "string", "required": false, "description": "云联网路由发布模式，可选值：`standard`（标准模式）、`exquisite`（精细模式）。只有云联网类型专线网关才支持修改`ModeType`。", "example": "standard" } ], "required": [ "DirectConnectGatewayId" ] }, { "name": "ModifyFlowLogAttribute", "description": "本接口（ModifyFlowLogAttribute）用于修改流日志属性。", "status": "online", "parameters": [ { "name": "FlowLogId", "type": "string", "required": true, "description": "流日志唯一ID。可通过[CreateFlowLog](https://cloud.tencent.com/document/product/215/35015)接口创建；可通过[DescribeFlowLogs](https://cloud.tencent.com/document/product/215/35012)接口获取。", "example": "fl-nswq8wkq" }, { "name": "VpcId", "type": "string", "required": false, "description": "私用网络唯一ID。修改云联网流日志属性时可不填，其他流日志类型必填。", "example": "vpc-pnpcflil" }, { "name": "FlowLogName", "type": "string", "required": false, "description": "流日志实例名称。长度为不超过60字符。", "example": "FlowLogName1" }, { "name": "FlowLogDescription", "type": "string", "required": false, "description": "流日志实例描述。长度为不超过512个字符。", "example": "FlowLogDescription1" }, { "name": "Period", "type": "integer", "required": false, "description": "流日志采集周期，只支持CCN类型流日志。 取值范围（单位s）：60， 300， 600。", "example": "300" } ], "required": [ "FlowLogId" ] }, { "name": "ModifyGatewayFlowQos", "description": "本接口（ModifyGatewayFlowQos）用于调整网关流控带宽。", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关实例ID，目前我们支持的网关实例类型有， 专线网关实例ID，形如，`dcg-ltjahce6`； Nat网关实例ID，形如，`nat-ltjahce6`； VPN网关实例ID，形如，`vpn-ltjahce6`。", "example": "vpngw-gree226l" }, { "name": "Bandwidth", "type": "integer", "required": true, "description": "流控带宽值。取值大于0，表示限流到指定的Mbps；取值等于0，表示完全限流；取值为-1，不限流。", "example": "10" }, { "name": "IpAddresses", "type": "array", "required": true, "description": "限流的云服务器内网IP。", "example": "10.0.0.2", "item_type": "string" } ], "required": [ "GatewayId", "Bandwidth", "IpAddresses" ] }, { "name": "ModifyGlobalRouteECMPAlgorithm", "description": "修改全局路由表ECMP算法 HASH 策略。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC唯一Id。", "example": "vpc-mcqaoy0f" }, { "name": "DestinationCidrBlock", "type": "string", "required": false, "description": "Ipv4目标网段。", "example": "192.168.0.0/20" }, { "name": "SubnetRouteAlgorithm", "type": "string", "required": false, "description": "支持的 ECMP算法有：ECMP_QUINTUPLE_HASH：五元组hash，ECMP_SOURCE_DESTINATION_IP_HASH：源和目的IP hash，ECMP_DESTINATION_IP_HASH：目的IP hash，ECMP_SOURCE_IP_HASH：源IP hash。", "example": "ECMP_QUINTUPLE_HASH" }, { "name": "CdcId", "type": "string", "required": false, "description": "CDC 集群唯一 ID。", "example": "cluster-d8htgb6k" } ], "required": [ "VpcId" ] }, { "name": "ModifyGlobalRoutes", "description": "修改全局路由。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC唯一Id。", "example": "vpc-mcqaoy0f" }, { "name": "GlobalRoutes", "type": "array", "required": true, "description": "全局路由对象。仅支持修改：'Description'，其他字段暂不支持。", "example": "[{\"Description\": \"ivan_gr\"}]", "item_type": "object", "children": [ { "name": "VpcId", "type": "string", "required": false, "description": "作为出参展示，表示VPC唯一Id，。", "example": "vpc-mcqaoy0f" }, { "name": "GlobalRouteId", "type": "string", "required": false, "description": "全局路由唯一Id。", "example": "gr-bmenrwu2" }, { "name": "DestinationCidrBlock", "type": "string", "required": false, "description": "Ipv4目标网段。", "example": "192.168.0.0/20" }, { "name": "GatewayType", "type": "string", "required": false, "description": "下一跳类型，支持 NORMAL_CVM。", "example": "NORMAL_CVM" }, { "name": "GatewayId", "type": "string", "required": false, "description": "下一跳对象，如果GatewayType类型是NORMAL_CVM填写子机IP。", "example": "192.168.0.3" }, { "name": "Description", "type": "string", "required": false, "description": "备注。", "example": "gr_item" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "创建时间。", "example": "2010-11-21" }, { "name": "SubnetRouteAlgorithm", "type": "string", "required": false, "description": "支持的 ECMP算法有： - ECMP_QUINTUPLE_HASH：五元组hash - ECMP_SOURCE_DESTINATION_IP_HASH：源和目的IP hash - ECMP_DESTINATION_IP_HASH：目的IP hash - ECMP_SOURCE_IP_HASH：源IP hash。", "example": "ECMP_QUINTUPLE_HASH" } ] } ], "required": [ "VpcId", "GlobalRoutes" ] }, { "name": "ModifyHaVipAttribute", "description": "本接口（ModifyHaVipAttribute）用于修改高可用虚拟IP（HAVIP）属性。", "status": "online", "parameters": [ { "name": "HaVipId", "type": "string", "required": true, "description": "`HAVIP`唯一`ID`，形如：`havip-9o233uri`。", "example": "havip-9o233uri" }, { "name": "HaVipName", "type": "string", "required": false, "description": "`HAVIP`名称，可任意命名，但不得超过60个字符。", "example": "demo" } ], "required": [ "HaVipId" ] }, { "name": "ModifyHighPriorityRouteAttribute", "description": "修改高优路由表条目属性。", "status": "online", "parameters": [ { "name": "HighPriorityRouteTableId", "type": "string", "required": true, "description": "高优路由表唯一 ID。", "example": "hprtb-18mot1fm" }, { "name": "HighPriorityModifyItems", "type": "array", "required": true, "description": "高优路由表条目修改属性。", "example": "无", "item_type": "object", "children": [ { "name": "HighPriorityRouteId", "type": "string", "required": false, "description": "高优路由条目唯一ID。", "example": "hprtb-kngiybxl" }, { "name": "Description", "type": "string", "required": false, "description": "高优路由条目描述。", "example": "demo" } ] } ], "required": [ "HighPriorityRouteTableId", "HighPriorityModifyItems" ] }, { "name": "ModifyHighPriorityRouteECMPAlgorithm", "description": "修改高优路由表 HASH 策略。", "status": "online", "parameters": [ { "name": "HighPriorityRouteTableId", "type": "string", "required": true, "description": "高优路由表实例唯一ID。", "example": "hprtb-18mot1fm" }, { "name": "RouteECMPAlgorithms", "type": "array", "required": true, "description": "高优路由表HASH策略。", "example": "[{\"SubnetRouteAlgorithm\": \"ECMP_SOURCE_DESTINATION_IP_HASH\", \"DestinationCidrBlock\": \"10.0.0.0/24\"}]", "item_type": "object", "children": [ { "name": "DestinationCidrBlock", "type": "string", "required": false, "description": "目标网段", "example": " 10.0.0.0/24" }, { "name": "SubnetRouteAlgorithm", "type": "string", "required": false, "description": "支持的 ECMP算法有：ECMP_QUINTUPLE_HASH：五元组hash，ECMP_SOURCE_DESTINATION_IP_HASH：源和目的IP hash，ECMP_DESTINATION_IP_HASH：目的IP hash，ECMP_SOURCE_IP_HASH：源IP hash。", "example": "ECMP_SOURCE_DESTINATION_IP_HASH" } ] } ], "required": [ "HighPriorityRouteTableId", "RouteECMPAlgorithms" ] }, { "name": "ModifyHighPriorityRouteTableAttribute", "description": "修改高优路由表属性", "status": "online", "parameters": [ { "name": "HighPriorityRouteTableId", "type": "string", "required": true, "description": "高优路由表表唯一ID", "example": "hprtb-896n82o4" }, { "name": "Name", "type": "string", "required": true, "description": "高优路由表表名称", "example": "demo" } ], "required": [ "HighPriorityRouteTableId", "Name" ] }, { "name": "ModifyIPv6AddressesAttributes", "description": "本接口（ModifyIPv6AddressesAttributes）用于修改弹性公网 IPv6（简称EIPv6）实例名称。 - 支持对弹性公网 IPv6 和传统弹性公网 IPv6 实例名称进行修改。", "status": "online", "parameters": [ { "name": "IPv6AddressIds", "type": "array", "required": true, "description": "弹性公网IPv6唯一ID列表。可以使用[DescribeIPv6Addresses](https://cloud.tencent.com/document/api/215/113677)接口获取IPv6AddressIds。", "example": "[\"eipv6-2ucdpy9t\"]", "item_type": "string" }, { "name": "IPv6AddressName", "type": "string", "required": false, "description": "弹性公网IPv6地址名称，长度上限为128个字符，允许使用大小写字母、汉字、数字、连字符\"-\"和下划线\"_\"，不能包含空格。", "example": "demo" } ], "required": [ "IPv6AddressIds" ] }, { "name": "ModifyIPv6AddressesBandwidth", "description": "本接口（ModifyIPv6AddressesBandwidth）用于调整弹性公网 IPv6（简称EIPv6）实例的带宽上限。", "status": "online", "parameters": [ { "name": "IPv6AddressIds", "type": "array", "required": true, "description": "弹性公网IPv6地址唯一ID，可以使用[DescribeIPv6Addresses](https://cloud.tencent.com/document/api/215/113677)接口获取IPv6AddressId。", "example": "[\"eipv6-3lxpc6sh\"]", "item_type": "string" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": true, "description": "弹性公网IPv6地址网络带宽，可调整的带宽上限值参考产品文档中[IPv6 计费限制说明](https://cloud.tencent.com/document/product/1142/38369#IPv6)。", "example": "10" } ], "required": [ "IPv6AddressIds", "InternetMaxBandwidthOut" ] }, { "name": "ModifyIp6AddressesBandwidth", "description": "本接口（ModifyIp6AddressesBandwidth）用于调整传统弹性公网 IPv6 实例的带宽上限。 - 仅支持对传统弹性公网 IPv6 实例的带宽上限进行调整。 - 如需调整弹性公网 IPv6 实例的带宽上限，请使用 [ModifyIPv6AddressesBandwidth](https://cloud.tencent.com/document/product/215/113674) 接口。", "status": "online", "parameters": [ { "name": "InternetMaxBandwidthOut", "type": "integer", "required": true, "description": "修改的目标带宽，单位Mbps。可调整的带宽上限值参考产品文档中[IPv6 计费限制说明](https://cloud.tencent.com/document/product/1142/38369#IPv6)。", "example": "50" }, { "name": "Ip6Addresses", "type": "array", "required": false, "description": "IPv6地址。可以使用[DescribeIp6Addresses](https://cloud.tencent.com/document/product/215/40089)接口查询Ip6Addresses。Ip6Addresses和Ip6AddressIds必须且只能传一个。", "example": "[\"2402:4e00:1000:200:0:8d8a:60b7:87f8\"]", "item_type": "string" }, { "name": "Ip6AddressIds", "type": "array", "required": false, "description": "IPv6地址对应的唯一ID，形如eip-xxxxxxxx。可以使用[DescribeIp6Addresses](https://cloud.tencent.com/document/product/215/40089)接口查询Ip6AddressIds。Ip6Addresses和Ip6AddressIds必须且只能传一个。", "example": "[\"eip-6kr6f42w\"]", "item_type": "string" } ], "required": [ "InternetMaxBandwidthOut" ] }, { "name": "ModifyIp6Rule", "description": "该接口用于修改IPV6转换规则，当前仅支持修改转换规则名称，IPV4地址和IPV4端口号", "status": "online", "parameters": [ { "name": "Ip6TranslatorId", "type": "string", "required": true, "description": "IPV6转换实例唯一ID，形如ip6-xxxxxxxx", "example": "ip6-90pt7p9q" }, { "name": "Ip6RuleId", "type": "string", "required": true, "description": "IPV6转换规则唯一ID，形如rule6-xxxxxxxx", "example": "rule6-7v3vwgec" }, { "name": "Ip6RuleName", "type": "string", "required": false, "description": "IPV6转换规则修改后的名称", "example": "\"rule_name\"" }, { "name": "Vip", "type": "string", "required": false, "description": "IPV6转换规则修改后的IPV4地址", "example": "100.192.3.9" }, { "name": "Vport", "type": "integer", "required": false, "description": "IPV6转换规则修改后的IPV4端口号", "example": "77" } ], "required": [ "Ip6TranslatorId", "Ip6RuleId" ] }, { "name": "ModifyIp6Translator", "description": "该接口用于修改IP6转换实例属性，当前仅支持修改实例名称。", "status": "online", "parameters": [ { "name": "Ip6TranslatorId", "type": "string", "required": true, "description": "IPV6转换实例唯一ID，形如ip6-xxxxxxxxx", "example": "ip6-kidc87ap" }, { "name": "Ip6TranslatorName", "type": "string", "required": false, "description": "IPV6转换实例修改名称", "example": "demo" } ], "required": [ "Ip6TranslatorId" ] }, { "name": "ModifyIpv6AddressesAttribute", "description": "本接口（ModifyIpv6AddressesAttribute）用于修改弹性网卡内网IPv6地址属性。", "status": "online", "parameters": [ { "name": "NetworkInterfaceId", "type": "string", "required": true, "description": "弹性网卡实例`ID`，形如：`eni-m6dyj72l`。可通过[DescribeNetworkInterfaces](https://cloud.tencent.com/document/product/215/15817)接口获取。", "example": "eni-m6dyj72l" }, { "name": "Ipv6Addresses", "type": "array", "required": true, "description": "指定的内网IPv6地址信息。", "example": "3402:4e00:20:1202::7", "item_type": "object", "children": [ { "name": "Address", "type": "string", "required": true, "description": "`IPv6`地址，形如：`3402:4e00:20:100:0:8cd9:2a67:71f3`", "example": "3402:4e00:20:1202::1" }, { "name": "Primary", "type": "boolean", "required": false, "description": "是否是主`IP`。", "example": "false" }, { "name": "AddressId", "type": "string", "required": false, "description": "`EIP`实例`ID`，形如：`eip-hxlqja90`。作为入参数时，可通过[DescribeAddresses](https://cloud.tencent.com/document/product/215/16702)接口获取。", "example": "eip-5k6fot41" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息。", "example": "demo" }, { "name": "IsWanIpBlocked", "type": "boolean", "required": false, "description": "公网IP是否被封堵。", "example": "false" }, { "name": "State", "type": "string", "required": false, "description": "`IPv6`地址状态： `PENDING`：生产中 `MIGRATING`：迁移中 `DELETING`：删除中 `AVAILABLE`：可用的", "example": "AVAILABLE" }, { "name": "PublicIpAddress", "type": "string", "required": false, "description": "如果 IPv6地址是 ULA 类型，绑定的公网IP地址。", "example": "3402:4e00:20:1202::2" }, { "name": "AddressType", "type": "string", "required": false, "description": "`IPv6`地址的类型: `GUA`(全球单播地址), `ULA`(唯一本地地址)", "example": "ULA" } ] } ], "required": [ "NetworkInterfaceId", "Ipv6Addresses" ] }, { "name": "ModifyLocalGateway", "description": "本接口（ModifyLocalGateway）用于修改CDC的本地网关。", "status": "online", "parameters": [ { "name": "LocalGatewayName", "type": "string", "required": true, "description": "本地网关名称。", "example": "demo" }, { "name": "CdcId", "type": "string", "required": true, "description": "CDC实例ID。", "example": "cluster-gbo27yc4" }, { "name": "LocalGatewayId", "type": "string", "required": true, "description": "本地网关实例ID。", "example": "lgw-1234ceww" }, { "name": "VpcId", "type": "string", "required": false, "description": "VPC实例ID。", "example": "vpc-m0c2kcun" } ], "required": [ "LocalGatewayName", "CdcId", "LocalGatewayId" ] }, { "name": "ModifyNatGatewayAttribute", "description": "本接口（ModifyNatGatewayAttribute）用于修改NAT网关的属性。", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "NAT网关的ID，形如：`nat-df45454`。", "example": "nat-ig8xpno8" }, { "name": "NatGatewayName", "type": "string", "required": false, "description": "NAT网关的名称，形如：`test_nat`，边界值：[1,60] 字符。", "example": "测试nat网关" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "NAT网关最大外网出带宽(单位:Mbps)，边界值：[0,50000]。", "example": "500" }, { "name": "ModifySecurityGroup", "type": "boolean", "required": false, "description": "是否修改NAT网关绑定的安全组。", "example": "true" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "NAT网关绑定的安全组列表，最终状态，空列表表示删除所有安全组，形如: `['sg-1n232323', 'sg-o4242424']`", "example": "[\"sg-1n232323\"]", "item_type": "string" }, { "name": "DeletionProtectionEnabled", "type": "boolean", "required": false, "description": "NAT实例是否开启删除保护", "example": "false" }, { "name": "PublicAddressAffinity", "type": "boolean", "required": false, "description": "同一个内网地址通过NAT网关访问同一个目的IP时，是否使用固定的弹性公网IP。默认为true，使用固定IP；false代表使用随机IP。当前适用于标准型NAT网关。", "example": "false" } ], "required": [ "NatGatewayId" ] }, { "name": "ModifyNatGatewayDestinationIpPortTranslationNatRule", "description": "本接口（ModifyNatGatewayDestinationIpPortTranslationNatRule）用于修改NAT网关端口转发规则。", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "NAT网关的ID，形如：`nat-df45454`。", "example": "nat-3isn9hr0" }, { "name": "SourceNatRule", "type": "object", "required": true, "description": "源NAT网关的端口转换规则。", "example": "无", "children": [ { "name": "IpProtocol", "type": "string", "required": true, "description": "网络协议，可选值：`TCP`、`UDP`。", "example": "TCP" }, { "name": "PublicIpAddress", "type": "string", "required": true, "description": "弹性IP。", "example": "114.182.81.73" }, { "name": "PublicPort", "type": "integer", "required": true, "description": "公网端口。", "example": "80" }, { "name": "PrivateIpAddress", "type": "string", "required": true, "description": "内网地址。", "example": "192.168.4.43" }, { "name": "PrivatePort", "type": "integer", "required": true, "description": "内网端口。", "example": "80" }, { "name": "Description", "type": "string", "required": false, "description": "NAT网关转发规则描述。", "example": "webservice" } ] }, { "name": "DestinationNatRule", "type": "object", "required": true, "description": "目的NAT网关的端口转换规则。", "example": "无", "children": [ { "name": "IpProtocol", "type": "string", "required": true, "description": "网络协议，可选值：`TCP`、`UDP`。", "example": "TCP" }, { "name": "PublicIpAddress", "type": "string", "required": true, "description": "弹性IP。", "example": "114.182.81.73" }, { "name": "PublicPort", "type": "integer", "required": true, "description": "公网端口。", "example": "80" }, { "name": "PrivateIpAddress", "type": "string", "required": true, "description": "内网地址。", "example": "192.168.4.43" }, { "name": "PrivatePort", "type": "integer", "required": true, "description": "内网端口。", "example": "80" }, { "name": "Description", "type": "string", "required": false, "description": "NAT网关转发规则描述。", "example": "webservice" } ] } ], "required": [ "NatGatewayId", "SourceNatRule", "DestinationNatRule" ] }, { "name": "ModifyNatGatewaySourceIpTranslationNatRule", "description": "本接口（ModifyNatGatewaySourceIpTranslationNatRule）用于修改NAT网关SNAT转发规则。", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "NAT网关的ID，形如：`nat-df453454`。", "example": "nat-3isn9hr0" }, { "name": "SourceIpTranslationNatRule", "type": "object", "required": true, "description": "NAT网关的SNAT转换规则。仅支持根据指定的NatGatewaySnatId修改PublicIpAddresses或Description。", "example": "无", "children": [ { "name": "ResourceId", "type": "string", "required": true, "description": "资源ID，如果ResourceType为USERDEFINED，可以为空字符串", "example": "subnet-7aed90al" }, { "name": "ResourceType", "type": "string", "required": true, "description": "资源类型，目前包含SUBNET、NETWORKINTERFACE、USERDEFINED，分别表示子网、网卡、自定义网段", "example": "SUBNET" }, { "name": "PrivateIpAddress", "type": "string", "required": true, "description": "源IP/网段", "example": "172.168.100.0/24" }, { "name": "PublicIpAddresses", "type": "array", "required": true, "description": "弹性IP地址池", "example": "['180.12.59.43']", "item_type": "string" }, { "name": "Description", "type": "string", "required": true, "description": "规则描述", "example": "production subnet" }, { "name": "NatGatewaySnatId", "type": "string", "required": false, "description": "Snat规则ID", "example": "snat-3nptcfvp" }, { "name": "NatGatewayId", "type": "string", "required": false, "description": "NAT网关的ID。", "example": "nat-3nptcfvp" }, { "name": "VpcId", "type": "string", "required": false, "description": "私有网络VPC的ID。", "example": "vpc-oty76xyl" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "NAT网关SNAT规则创建时间。", "example": "2021-03-14 13:59:00" } ] } ], "required": [ "NatGatewayId", "SourceIpTranslationNatRule" ] }, { "name": "ModifyNetDetect", "description": "本接口(ModifyNetDetect)用于修改网络探测参数。", "status": "online", "parameters": [ { "name": "NetDetectId", "type": "string", "required": true, "description": "网络探测实例`ID`。形如：`netd-12345678`", "example": "netd-hj3he929" }, { "name": "NetDetectName", "type": "string", "required": false, "description": "网络探测名称，最大长度不能超过60个字节。", "example": "demo" }, { "name": "DetectDestinationIp", "type": "array", "required": false, "description": "探测目的IPv4地址数组，最多两个。", "example": "[\"10.0.0.2\",\"10.0.0.3\"]", "item_type": "string" }, { "name": "NextHopType", "type": "string", "required": false, "description": "下一跳类型，目前我们支持的类型有： VPN：VPN网关； DIRECTCONNECT：专线网关； PEERCONNECTION：对等连接； NAT：NAT网关； NORMAL_CVM：普通云服务器； CCN：云联网网关； NONEXTHOP：无下一跳；", "example": "NORMAL_CVM" }, { "name": "NextHopDestination", "type": "string", "required": false, "description": "下一跳目的网关，取值与“下一跳类型”相关： 下一跳类型为VPN，取值VPN网关ID，形如：vpngw-12345678； 下一跳类型为DIRECTCONNECT，取值专线网关ID，形如：dcg-12345678； 下一跳类型为PEERCONNECTION，取值对等连接ID，形如：pcx-12345678； 下一跳类型为NAT，取值Nat网关，形如：nat-12345678； 下一跳类型为NORMAL_CVM，取值云服务器IPv4地址，形如：10.0.0.12； 下一跳类型为CCN，取值云联网ID，形\ufffd\ufffd...", "example": "10.0.0.4" }, { "name": "NetDetectDescription", "type": "string", "required": false, "description": "网络探测描述。", "example": "demo" } ], "required": [ "NetDetectId" ] }, { "name": "ModifyNetworkAclAttribute", "description": "本接口（ModifyNetworkAclAttribute）用于修改网络ACL属性。", "status": "online", "parameters": [ { "name": "NetworkAclId", "type": "string", "required": true, "description": "网络ACL实例ID。例如：acl-12345678。", "example": "acl-12345678" }, { "name": "NetworkAclName", "type": "string", "required": true, "description": "网络ACL名称，最大长度不能超过60个字节。", "example": "test modify" } ], "required": [ "NetworkAclId", "NetworkAclName" ] }, { "name": "ModifyNetworkAclEntries", "description": "本接口（ModifyNetworkAclEntries）用于修改（包括添加和删除）网络ACL的入站规则和出站规则。在NetworkAclEntrySet参数中： * 若同时传入入站规则和出站规则，则重置原有的入站规则和出站规则，并分别导入传入的规则。 * 若仅传入入站规则，则仅重置原有的入站规则，并导入传入的规则，不影响原有的出站规则（若仅传入出站规则，处理方式类似入站方向）。", "status": "online", "parameters": [ { "name": "NetworkAclId", "type": "string", "required": true, "description": "网络ACL实例ID。例如：acl-12345678。", "example": "acl-hj3he929" }, { "name": "NetworkAclEntrySet", "type": "object", "required": false, "description": "网络ACL规则集。NetworkAclEntrySet和NetworkAclQuintupleSet只能输入一个。", "example": "{\"Ingress\": [{\"Protocol\": \"all\", \"CidrBlock\": \"10.0.0.0/24\", \"Action\": \"ACCEPT\", \"Description\": \"demo\"}], \"Egress\": [{\"Protocol\": \"all\", \"CidrBlock\": \"0.0.0.0/0\", \"Action\": \"ACCEPT\", \"Description\": \"demo\"}]}", "children": [ { "name": "Ingress", "type": "array", "required": false, "description": "入站规则。", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP, ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。使用-指定端口范围，如：10-20。", "example": "8080" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)。增量创建ACL规则时，CidrBlock和Ipv6CidrBlock至少提供一个。", "example": "10.0.0.0/24" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。", "example": "3402:4e00:20:1200::/56" }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "Description", "type": "string", "required": false, "description": "规则描述，最大长度100。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间。", "example": "2018-04-25 10:26:26" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级，从1开始。", "example": "1" }, { "name": "NetworkAclIpv4EntryId", "type": "string", "required": false, "description": "IPv4网络ACL条目唯一ID。当修改ACL条目时，NetworkAclIpv4EntryId和NetworkAclIpv6EntryID至少提供一个。", "example": "acli43-0pngbwph" }, { "name": "NetworkAclIpv6EntryId", "type": "string", "required": false, "description": "IPv6网络ACL条目唯一ID。当修改ACL条目时，NetworkAclIpv4EntryId和NetworkAclIpv6EntryId至少提供一个。", "example": "acli46-0pngbwph" } ] }, { "name": "Egress", "type": "array", "required": false, "description": "出站规则。", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP, ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。使用-指定端口范围，如：10-20。", "example": "8080" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)。增量创建ACL规则时，CidrBlock和Ipv6CidrBlock至少提供一个。", "example": "10.0.0.0/24" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。", "example": "3402:4e00:20:1200::/56" }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "Description", "type": "string", "required": false, "description": "规则描述，最大长度100。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间。", "example": "2018-04-25 10:26:26" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级，从1开始。", "example": "1" }, { "name": "NetworkAclIpv4EntryId", "type": "string", "required": false, "description": "IPv4网络ACL条目唯一ID。当修改ACL条目时，NetworkAclIpv4EntryId和NetworkAclIpv6EntryID至少提供一个。", "example": "acli43-0pngbwph" }, { "name": "NetworkAclIpv6EntryId", "type": "string", "required": false, "description": "IPv6网络ACL条目唯一ID。当修改ACL条目时，NetworkAclIpv4EntryId和NetworkAclIpv6EntryId至少提供一个。", "example": "acli46-0pngbwph" } ] } ] }, { "name": "NetworkAclQuintupleSet", "type": "object", "required": false, "description": "网络ACL五元组规则集。NetworkAclEntrySet和NetworkAclQuintupleSet只能输入一个。", "example": "{ \"Ingress\": [ { \"Protocol\": \"TCP\", \"Description\": \"TCP TEST\", \"SourcePort\": \"80\", \"SourceCidr\": \"192.168.0.0/24\", \"DestinationPort\": \"8080\", \"DestinationCidr\": \"10.0.0.0/24\", \"Action\": \"ACCEPT\", \"Priority\": 1 } ] }", "children": [ { "name": "Ingress", "type": "array", "required": false, "description": "网络ACL五元组入站规则。", "example": "[{ 'SourcePort':'446', 'SourceCidr': '10.0.0.2/24', 'Protocol': ", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP, ALL。", "example": "UDP" }, { "name": "Description", "type": "string", "required": false, "description": "描述。", "example": "demo" }, { "name": "SourcePort", "type": "string", "required": false, "description": "源端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。", "example": "446" }, { "name": "SourceCidr", "type": "string", "required": false, "description": "源CIDR。", "example": "192.168.0.0/24" }, { "name": "DestinationPort", "type": "string", "required": false, "description": "目的端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。", "example": "446" }, { "name": "DestinationCidr", "type": "string", "required": false, "description": "目的CIDR。", "example": "192.168.0.0/24" }, { "name": "Action", "type": "string", "required": false, "description": "动作，ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "NetworkAclQuintupleEntryId", "type": "string", "required": false, "description": "网络ACL条目唯一ID。", "example": "acli45-ahnu4rv5" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级，从1开始。", "example": "1" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间，用于DescribeNetworkAclQuintupleEntries的出参。", "example": "2021-03-02 14:41:15" }, { "name": "NetworkAclDirection", "type": "string", "required": false, "description": "方向，INGRESS或EGRESS，用于DescribeNetworkAclQuintupleEntries的出参。", "example": "INGRESS" }, { "name": "SourceIPv6Cidr", "type": "string", "required": false, "description": "IPv6源CIDR。", "example": "12::1/128" }, { "name": "DestinationIPv6Cidr", "type": "string", "required": false, "description": "IPv6目的CIDR。", "example": "13::1/128" } ] }, { "name": "Egress", "type": "array", "required": false, "description": "网络ACL五元组出站规则", "example": "[{ 'SourcePort':'446', 'SourceCidr': '10.0.0.2/24', 'Protocol': ", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP, ALL。", "example": "UDP" }, { "name": "Description", "type": "string", "required": false, "description": "描述。", "example": "demo" }, { "name": "SourcePort", "type": "string", "required": false, "description": "源端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。", "example": "446" }, { "name": "SourceCidr", "type": "string", "required": false, "description": "源CIDR。", "example": "192.168.0.0/24" }, { "name": "DestinationPort", "type": "string", "required": false, "description": "目的端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。", "example": "446" }, { "name": "DestinationCidr", "type": "string", "required": false, "description": "目的CIDR。", "example": "192.168.0.0/24" }, { "name": "Action", "type": "string", "required": false, "description": "动作，ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "NetworkAclQuintupleEntryId", "type": "string", "required": false, "description": "网络ACL条目唯一ID。", "example": "acli45-ahnu4rv5" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级，从1开始。", "example": "1" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间，用于DescribeNetworkAclQuintupleEntries的出参。", "example": "2021-03-02 14:41:15" }, { "name": "NetworkAclDirection", "type": "string", "required": false, "description": "方向，INGRESS或EGRESS，用于DescribeNetworkAclQuintupleEntries的出参。", "example": "INGRESS" }, { "name": "SourceIPv6Cidr", "type": "string", "required": false, "description": "IPv6源CIDR。", "example": "12::1/128" }, { "name": "DestinationIPv6Cidr", "type": "string", "required": false, "description": "IPv6目的CIDR。", "example": "13::1/128" } ] } ] }, { "name": "EnableUpdateAclEntries", "type": "boolean", "required": false, "description": "三元组的增量更新。该接口的默认语义为全量覆盖。当需要实现增量更新语义时，设置该参数为True。", "example": "true" } ], "required": [ "NetworkAclId" ] }, { "name": "ModifyNetworkAclQuintupleEntries", "description": "本接口（ModifyNetworkAclQuintupleEntries）用于修改网络ACL五元组的入站规则和出站规则。在NetworkAclQuintupleEntrySet参数中：NetworkAclQuintupleEntry需要提供NetworkAclQuintupleEntryId。", "status": "online", "parameters": [ { "name": "NetworkAclId", "type": "string", "required": true, "description": "网络ACL实例ID。例如：acl-12345678。", "example": "acl-12345678" }, { "name": "NetworkAclQuintupleSet", "type": "object", "required": true, "description": "网络五元组ACL规则集。", "example": "无", "children": [ { "name": "Ingress", "type": "array", "required": false, "description": "网络ACL五元组入站规则。", "example": "[{ 'SourcePort':'446', 'SourceCidr': '10.0.0.2/24', 'Protocol': ", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP, ALL。", "example": "UDP" }, { "name": "Description", "type": "string", "required": false, "description": "描述。", "example": "demo" }, { "name": "SourcePort", "type": "string", "required": false, "description": "源端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。", "example": "446" }, { "name": "SourceCidr", "type": "string", "required": false, "description": "源CIDR。", "example": "192.168.0.0/24" }, { "name": "DestinationPort", "type": "string", "required": false, "description": "目的端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。", "example": "446" }, { "name": "DestinationCidr", "type": "string", "required": false, "description": "目的CIDR。", "example": "192.168.0.0/24" }, { "name": "Action", "type": "string", "required": false, "description": "动作，ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "NetworkAclQuintupleEntryId", "type": "string", "required": false, "description": "网络ACL条目唯一ID。", "example": "acli45-ahnu4rv5" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级，从1开始。", "example": "1" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间，用于DescribeNetworkAclQuintupleEntries的出参。", "example": "2021-03-02 14:41:15" }, { "name": "NetworkAclDirection", "type": "string", "required": false, "description": "方向，INGRESS或EGRESS，用于DescribeNetworkAclQuintupleEntries的出参。", "example": "INGRESS" }, { "name": "SourceIPv6Cidr", "type": "string", "required": false, "description": "IPv6源CIDR。", "example": "12::1/128" }, { "name": "DestinationIPv6Cidr", "type": "string", "required": false, "description": "IPv6目的CIDR。", "example": "13::1/128" } ] }, { "name": "Egress", "type": "array", "required": false, "description": "网络ACL五元组出站规则", "example": "[{ 'SourcePort':'446', 'SourceCidr': '10.0.0.2/24', 'Protocol': ", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP, ALL。", "example": "UDP" }, { "name": "Description", "type": "string", "required": false, "description": "描述。", "example": "demo" }, { "name": "SourcePort", "type": "string", "required": false, "description": "源端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。", "example": "446" }, { "name": "SourceCidr", "type": "string", "required": false, "description": "源CIDR。", "example": "192.168.0.0/24" }, { "name": "DestinationPort", "type": "string", "required": false, "description": "目的端口(all, 单个port, range)。当Protocol为ALL或ICMP时，不能指定Port。", "example": "446" }, { "name": "DestinationCidr", "type": "string", "required": false, "description": "目的CIDR。", "example": "192.168.0.0/24" }, { "name": "Action", "type": "string", "required": false, "description": "动作，ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "NetworkAclQuintupleEntryId", "type": "string", "required": false, "description": "网络ACL条目唯一ID。", "example": "acli45-ahnu4rv5" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级，从1开始。", "example": "1" }, { "name": "CreateTime", "type": "string", "required": false, "description": "创建时间，用于DescribeNetworkAclQuintupleEntries的出参。", "example": "2021-03-02 14:41:15" }, { "name": "NetworkAclDirection", "type": "string", "required": false, "description": "方向，INGRESS或EGRESS，用于DescribeNetworkAclQuintupleEntries的出参。", "example": "INGRESS" }, { "name": "SourceIPv6Cidr", "type": "string", "required": false, "description": "IPv6源CIDR。", "example": "12::1/128" }, { "name": "DestinationIPv6Cidr", "type": "string", "required": false, "description": "IPv6目的CIDR。", "example": "13::1/128" } ] } ] } ], "required": [ "NetworkAclId", "NetworkAclQuintupleSet" ] }, { "name": "ModifyNetworkInterfaceAttribute", "description": "本接口（ModifyNetworkInterfaceAttribute）用于修改弹性网卡属性。", "status": "online", "parameters": [ { "name": "NetworkInterfaceId", "type": "string", "required": true, "description": "弹性网卡实例ID，例如：eni-pxir56ns。可通过[DescribeNetworkInterfaces](https://cloud.tencent.com/document/product/215/15817)接口获取。", "example": "eni-afo43z61" }, { "name": "NetworkInterfaceName", "type": "string", "required": false, "description": "弹性网卡名称，最大长度不能超过60个字节。", "example": "NetworkInterfaceName1" }, { "name": "NetworkInterfaceDescription", "type": "string", "required": false, "description": "弹性网卡描述，可任意命名，但不得超过60个字符。", "example": "NetworkInterfaceDescription1" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "指定绑定的安全组，例如:['sg-1dd51d']。可通过[DescribeSecurityGroups](https://cloud.tencent.com/document/product/215/15808)接口获取。", "example": "[\"sg-h0fk8lfc\"]", "item_type": "string" }, { "name": "TrunkingFlag", "type": "string", "required": false, "description": "网卡trunking模式设置，Enable-开启，Disable--关闭，默认关闭。", "example": "Enable" } ], "required": [ "NetworkInterfaceId" ] }, { "name": "ModifyNetworkInterfaceQos", "description": "本接口（ModifyNetworkInterfaceQos）用于修改弹性网卡服务质量。", "status": "online", "parameters": [ { "name": "NetworkInterfaceIds", "type": "array", "required": true, "description": "弹性网卡ID，支持批量修改。可通过[DescribeNetworkInterfaces](https://cloud.tencent.com/document/product/215/15817)接口获取。", "example": "[\"eni-nswq8wkq\"]", "item_type": "string" }, { "name": "QosLevel", "type": "string", "required": false, "description": "服务质量，可选值：PT（云金）、AU（云银）、AG(云铜）、DEFAULT（默认）。", "example": "AG" }, { "name": "DirectSendMaxPort", "type": "integer", "required": false, "description": "DirectSend端口范围最大值。最大值: 65535。", "example": "8090" } ], "required": [ "NetworkInterfaceIds" ] }, { "name": "ModifyPrivateIpAddressesAttribute", "description": "本接口（ModifyPrivateIpAddressesAttribute）用于修改弹性网卡内网IP属性。", "status": "online", "parameters": [ { "name": "NetworkInterfaceId", "type": "string", "required": true, "description": "弹性网卡实例ID，例如：eni-m6dyj72l。可通过[DescribeNetworkInterfaces](https://cloud.tencent.com/document/product/215/15817)接口获取。", "example": "eni-afo43z61" }, { "name": "PrivateIpAddresses", "type": "array", "required": true, "description": "指定的内网IP信息。", "example": "[{'PrivateIpAddress': '172.16.32.11','Description': 'new-desc--------' }]", "item_type": "object", "children": [ { "name": "PrivateIpAddress", "type": "string", "required": false, "description": "内网IP地址。", "example": "192.168.0.10" }, { "name": "Primary", "type": "boolean", "required": false, "description": "是否是主IP。", "example": "false" }, { "name": "PublicIpAddress", "type": "string", "required": false, "description": "公网IP地址。", "example": "123.10.100.171" }, { "name": "AddressId", "type": "string", "required": false, "description": "EIP实例ID，例如：eip-11112222。", "example": "eip-29mdigub" }, { "name": "Description", "type": "string", "required": false, "description": "内网IP描述信息。", "example": "demo" }, { "name": "IsWanIpBlocked", "type": "boolean", "required": false, "description": "公网IP是否被封堵。", "example": "false" }, { "name": "State", "type": "string", "required": false, "description": "IP状态： PENDING：生产中 MIGRATING：迁移中 DELETING：删除中 AVAILABLE：可用的", "example": "AVAILABLE" }, { "name": "QosLevel", "type": "string", "required": false, "description": "IP服务质量等级，可选值：PT（云金）、AU（云银）、AG(云铜）、DEFAULT（默认）。", "example": "PT" } ] } ], "required": [ "NetworkInterfaceId", "PrivateIpAddresses" ] }, { "name": "ModifyPrivateNatGatewayAttribute", "description": "本接口（ModifyPrivateNatGatewayAttribute）用于修改私网NAT网关属性", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "私网网关唯一`ID`，形如：`intranat-xxxxxxxx`。", "example": "intranat-0g3blj80" }, { "name": "NatGatewayName", "type": "string", "required": false, "description": "私网网关名称，可任意命名，但不得超过60个字符。", "example": "newtest" }, { "name": "DeletionProtectionEnabled", "type": "boolean", "required": false, "description": "私网NAT实例是否开启删除保护", "example": "false" } ], "required": [ "NatGatewayId" ] }, { "name": "ModifyPrivateNatGatewayDestinationIpPortTranslationNatRule", "description": "本接口（ModifyPrivateNatGatewayDestinationIpPortTranslationNatRule）用于修改私网NAT网关目的端口转换规则", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "私网网关唯一`ID`，形如：`intranat-xxxxxxxx`。", "example": "intranat-0g3blj80" }, { "name": "LocalDestinationIpPortTranslationNatRules", "type": "array", "required": true, "description": "目的端口转换规则列表。", "example": "无", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "协议", "example": "\"TCP\"" }, { "name": "OriginalPort", "type": "integer", "required": true, "description": "映射前端口", "example": "80" }, { "name": "OriginalIp", "type": "string", "required": true, "description": "映射前IP", "example": "\"10.0.13.19\"" }, { "name": "TranslationPort", "type": "integer", "required": true, "description": "映射后端口", "example": "8081" }, { "name": "TranslationIp", "type": "string", "required": true, "description": "映射后IP", "example": "\"10.0.13.1\"" }, { "name": "OldProtocol", "type": "string", "required": true, "description": "旧协议。", "example": "\"UDP\"" }, { "name": "OldOriginalPort", "type": "integer", "required": true, "description": "旧映射前端口", "example": "80" }, { "name": "OldOriginalIp", "type": "string", "required": true, "description": "旧映射前IP", "example": "\"10.0.13.19\"" }, { "name": "OldTranslationPort", "type": "integer", "required": true, "description": "旧映射后端口", "example": "8081" }, { "name": "OldTranslationIp", "type": "string", "required": true, "description": "旧映射后IP", "example": "\"10.0.13.1\"" }, { "name": "Description", "type": "string", "required": false, "description": "描述", "example": "webservice" } ] } ], "required": [ "NatGatewayId", "LocalDestinationIpPortTranslationNatRules" ] }, { "name": "ModifyPrivateNatGatewayTranslationAclRule", "description": "本接口（ModifyPrivateNatGatewayTranslationAclRule）用于修改私网NAT网关源端转换访问控制规则", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "私网网关唯一`ID`，形如：`intranat-xxxxxxxx`。", "example": "intranat-0g3blj80" }, { "name": "TranslationDirection", "type": "string", "required": true, "description": "转换规则目标，可选值\"LOCAL\"。", "example": "\"LOCAL\"" }, { "name": "TranslationType", "type": "string", "required": true, "description": "转换规则类型，可选值\"NETWORK_LAYER\",\"TRANSPORT_LAYER\"。", "example": "NETWORK_LAYER" }, { "name": "TranslationIp", "type": "string", "required": true, "description": "转换`IP`,当转换规则类型为四层时为`IP`池", "example": "\"10.0.13.20\"" }, { "name": "TranslationAclRules", "type": "array", "required": true, "description": "访问控制列表，需要附带AclRuleId参数。", "example": "无", "item_type": "object", "children": [ { "name": "Protocol", "type": "string", "required": true, "description": "ACL协议类型，可选值:\"ALL\",\"TCP\",\"UDP\"", "example": "\"ALL\"" }, { "name": "SourcePort", "type": "string", "required": true, "description": "源端口。", "example": "\"80\"" }, { "name": "DestinationPort", "type": "string", "required": true, "description": "目的端口。", "example": "\"8081\"" }, { "name": "DestinationCidr", "type": "string", "required": true, "description": "目的地址。", "example": "\"100.0.20.3\"" }, { "name": "SourceCidr", "type": "string", "required": false, "description": "源地址。支持`ip`或`cidr`格式\"xxx.xxx.xxx.000/xx\"", "example": "\"127.0.0.1\"" }, { "name": "AclRuleId", "type": "integer", "required": false, "description": "ACL规则`ID`。", "example": "1" }, { "name": "Action", "type": "integer", "required": false, "description": "是否匹配。", "example": "0" }, { "name": "Description", "type": "string", "required": false, "description": "ACL规则描述", "example": "\"ACL规则描述\"" } ] }, { "name": "OriginalIp", "type": "string", "required": false, "description": "源`IP`,当转换规则类型为三层时有效", "example": "\"10.0.13.19\"" } ], "required": [ "NatGatewayId", "TranslationDirection", "TranslationType", "TranslationIp", "TranslationAclRules" ] }, { "name": "ModifyPrivateNatGatewayTranslationNatRule", "description": "本接口（ModifyPrivateNatGatewayTranslationNatRule）用于修改私网NAT网关源端转换规则", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "私网网关唯一`ID`，形如：`intranat-xxxxxxxx`。", "example": "intranat-0g3blj80" }, { "name": "TranslationNatRules", "type": "array", "required": true, "description": "转换规则对象数组。仅支持修改单个转换规则", "example": "无", "item_type": "object", "children": [ { "name": "TranslationDirection", "type": "string", "required": true, "description": "转发规则目标，可选值\"LOCAL\",\"PEER\"。", "example": "\"LOCAL\"" }, { "name": "TranslationType", "type": "string", "required": true, "description": "转换规则类型，可选值\"NETWORK_LAYER\",\"TRANSPORT_LAYER\"。分别对应三层、四层。", "example": "\"NETWORK_LAYER\"" }, { "name": "TranslationIp", "type": "string", "required": true, "description": "转发规则映射后`IP`,当转发规则类型为四层时为`IP`池", "example": "\"10.0.13.21\"" }, { "name": "OldTranslationIp", "type": "string", "required": true, "description": "旧转发规则映射后`IP`,当转发规则类型为四层时为`IP`池", "example": "\"10.0.13.21\"" }, { "name": "Description", "type": "string", "required": false, "description": "转发规则描述。", "example": "my service" }, { "name": "OriginalIp", "type": "string", "required": false, "description": "新转发规则映射前`IP`,当转发规则类型为三层时有效", "example": "\"10.0.13.20\"" }, { "name": "OldOriginalIp", "type": "string", "required": false, "description": "旧转发规则映射前`IP`,当转发规则类型为三层时有效", "example": "\"10.0.13.19\"" } ] }, { "name": "CrossDomain", "type": "boolean", "required": false, "description": "跨域参数，当VPC为跨域时填写为True。", "example": "true" } ], "required": [ "NatGatewayId", "TranslationNatRules" ] }, { "name": "ModifyReserveIpAddress", "description": "修改内网保留 IP", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC唯一 ID。", "example": "vpc-mcqaoy0f" }, { "name": "ReserveIpId", "type": "string", "required": true, "description": "内网保留IP唯一ID。", "example": "rsvip-pvqgv9vi" }, { "name": "Name", "type": "string", "required": false, "description": "内网保留 IP名称。", "example": "name_ivan" }, { "name": "Description", "type": "string", "required": false, "description": "内网保留 IP描述。", "example": "desc_ivan" } ], "required": [ "VpcId", "ReserveIpId" ] }, { "name": "ModifyRoutePolicyAttribute", "description": "本接口（ModifyRoutePolicyAttribute）用于修改路由接收策略属性属性。", "status": "online", "parameters": [ { "name": "RoutePolicyId", "type": "string", "required": true, "description": "路由接收策略实例ID，例如：rrp-dz0219jq。", "example": "rrp-dz0219jq" }, { "name": "RoutePolicyName", "type": "string", "required": true, "description": "路由接收策略名称。", "example": "name" }, { "name": "RoutePolicyDescription", "type": "string", "required": true, "description": "路由接收策略描述。", "example": "TEST" } ], "required": [ "RoutePolicyId", "RoutePolicyName", "RoutePolicyDescription" ] }, { "name": "ModifyRouteTableAttribute", "description": "本接口（ModifyRouteTableAttribute）用于修改路由表（RouteTable）属性。", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表实例ID，例如：rtb-azd4dt1c。", "example": "rtb-azd4dt1c" }, { "name": "RouteTableName", "type": "string", "required": true, "description": "路由表名称。", "example": "name" } ], "required": [ "RouteTableId", "RouteTableName" ] }, { "name": "ModifyRouteTableSelectionPolicies", "description": "该接口用于编辑云联网路由表选择策略", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "云联网ID。", "example": "ccnrtb-1234edfr" }, { "name": "SelectionPolicies", "type": "array", "required": true, "description": "选择策略信息集合，表示需要按照当前的策略来修改。", "example": "-", "item_type": "object", "children": [ { "name": "InstanceType", "type": "string", "required": true, "description": "实例类型： 私有网络: `VPC` 专线网关: `DIRECTCONNECT` 黑石私有网络: `BMVPC` EDGE设备: `EDGE` EDGE隧道: `EDGE_TUNNEL` EDGE网关: `EDGE_VPNGW` VPN网关：`VPNGW`", "example": "VPC" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。", "example": "vpc-m0c2kcun" }, { "name": "SourceCidrBlock", "type": "string", "required": true, "description": "源端CIDR。", "example": "10.0.0.0/16" }, { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表ID。", "example": "ccnrtb-1234edfr" }, { "name": "Description", "type": "string", "required": false, "description": "路由表备注。", "example": "rtb-1" } ] } ], "required": [ "CcnId", "SelectionPolicies" ] }, { "name": "ModifySecurityGroupAttribute", "description": "本接口（ModifySecurityGroupAttribute）用于修改安全组（SecurityGroupPolicy）属性。", "status": "online", "parameters": [ { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组实例ID，例如sg-33ocnj9n，可通过DescribeSecurityGroups获取。", "example": "sg-33ocnj9n" }, { "name": "GroupName", "type": "string", "required": false, "description": "安全组名称，可任意命名，但不得超过60个字符。", "example": "demo" }, { "name": "GroupDescription", "type": "string", "required": false, "description": "安全组备注，最多100个字符。", "example": "demo" } ], "required": [ "SecurityGroupId" ] }, { "name": "ModifySecurityGroupPolicies", "description": "本接口（ModifySecurityGroupPolicies）用于重置安全组出站和入站规则（SecurityGroupPolicy）。 该接口不支持自定义索引 PolicyIndex。 在 SecurityGroupPolicySet 参数中： 如果指定 SecurityGroupPolicySet.Version 为0, 表示清空所有规则，并忽略 Egress 和 Ingress。 如果指定 SecurityGroupPolicySet.Version 不为0, 在添加出站和入站规则（Egress 和 Ingress）时： Protocol 字段支持输入 TCP, UDP, ICMP, ICMPV6, GRE, ALL。 CidrBlock \ufffd...", "status": "online", "parameters": [ { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组实例ID，例如sg-33ocnj9n，可通过DescribeSecurityGroups获取。", "example": "sg-ohuuioma" }, { "name": "SecurityGroupPolicySet", "type": "object", "required": true, "description": "安全组规则集合。 SecurityGroupPolicySet对象必须同时指定新的出（Egress）入（Ingress）站规则。 SecurityGroupPolicy对象不支持自定义索引（PolicyIndex）。", "example": "ppm-f5n1f8da", "children": [ { "name": "Version", "type": "string", "required": false, "description": "安全组规则当前版本。用户每次更新安全规则版本会自动加1，防止更新的路由规则已过期，不填不考虑冲突。", "example": "10" }, { "name": "Egress", "type": "array", "required": false, "description": "出站规则。", "example": "[{\"PolicyIndex\": 0, \"Port\": \"443\", \"CidrBlock\": \"10.0.0.0/24\", \"Action\": \"ACCEPT\", \"ModifyTime\": \"2020-10-09 10:00:00\", \"PolicyDescription\": \"\", \"Protocol\": \"tcp\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号，值会随着安全组规则的变更动态变化。使用PolicyIndex时，请先调用`DescribeSecurityGroupPolicies`获取到规则的PolicyIndex，并且结合返回值中的Version一起使用处理规则。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP,ICMP,ICMPv6,ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。 说明：如果Protocol设置为ALL，则Port也需要设置为all。", "example": "22" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "ppm-8g7k5qfq", "children": [ { "name": "ServiceId", "type": "string", "required": false, "description": "协议端口ID，例如：ppm-f5n1f8da。", "example": "ppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": false, "description": "协议端口组ID，例如：ppmg-f5n1f8da。", "example": "ppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)，特殊说明：0.0.0.0/n 都会映射为0.0.0.0/0。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IP地址。", "example": "10.0.0.0/16" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IPv6地址。", "example": "::/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：sg-ohuuioma。", "example": "sg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者IP地址组ID。", "example": "ipm-p5sf61yj", "children": [ { "name": "AddressId", "type": "string", "required": false, "description": "IP地址ID，例如：ipm-2uw6ujo6。", "example": "ipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": false, "description": "IP地址组ID，例如：ipmg-2uw6ujo6。", "example": "ipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。作为入参时，当未传递该参数或值为空，且参数CidrBlock或Ipv6CidrBlock值为MY_PUBLIC_IP时，该参数的值将会被自动填充为Replaced-From-MY_PUBLIC_IP。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "安全组最近修改时间。", "example": "2021-03-02 14:41:15" }, { "name": "Priority", "type": "integer", "required": false, "description": "安全组规则优先级，值会随着安全组规则的变更动态变化。使用Priority时，请先调用`DescribeSecurityGroupPolicies`获取到规则的Priority，并且结合返回值中的Version一起使用处理规则。" } ] }, { "name": "Ingress", "type": "array", "required": false, "description": "入站规则。", "example": "[{\"PolicyIndex\": 0, \"Port\": \"443\", \"CidrBlock\": \"0.0.0.0/0\", \"Action\": \"ACCEPT\", \"ModifyTime\": \"2020-10-09 10:00:00\", \"PolicyDescription\": \"\", \"Protocol\": \"tcp\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号，值会随着安全组规则的变更动态变化。使用PolicyIndex时，请先调用`DescribeSecurityGroupPolicies`获取到规则的PolicyIndex，并且结合返回值中的Version一起使用处理规则。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP,ICMP,ICMPv6,ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。 说明：如果Protocol设置为ALL，则Port也需要设置为all。", "example": "22" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "ppm-8g7k5qfq", "children": [ { "name": "ServiceId", "type": "string", "required": false, "description": "协议端口ID，例如：ppm-f5n1f8da。", "example": "ppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": false, "description": "协议端口组ID，例如：ppmg-f5n1f8da。", "example": "ppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)，特殊说明：0.0.0.0/n 都会映射为0.0.0.0/0。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IP地址。", "example": "10.0.0.0/16" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IPv6地址。", "example": "::/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：sg-ohuuioma。", "example": "sg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者IP地址组ID。", "example": "ipm-p5sf61yj", "children": [ { "name": "AddressId", "type": "string", "required": false, "description": "IP地址ID，例如：ipm-2uw6ujo6。", "example": "ipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": false, "description": "IP地址组ID，例如：ipmg-2uw6ujo6。", "example": "ipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。作为入参时，当未传递该参数或值为空，且参数CidrBlock或Ipv6CidrBlock值为MY_PUBLIC_IP时，该参数的值将会被自动填充为Replaced-From-MY_PUBLIC_IP。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "安全组最近修改时间。", "example": "2021-03-02 14:41:15" }, { "name": "Priority", "type": "integer", "required": false, "description": "安全组规则优先级，值会随着安全组规则的变更动态变化。使用Priority时，请先调用`DescribeSecurityGroupPolicies`获取到规则的Priority，并且结合返回值中的Version一起使用处理规则。" } ] }, { "name": "PolicyStatistics", "type": "object", "required": false, "description": "安全组策略条目统计。只用于出参。", "example": "{\"IngressIPv4TotalCount\": 1, \"IngressIPv6TotalCount\": 0, \"EgressIPv4TotalCount\": 1, \"EgressIPv6TotalCount\": 0}", "children": [ { "name": "IngressIPv4TotalCount", "type": "integer", "required": true, "description": "入站IPv4总数", "example": "1" }, { "name": "IngressIPv6TotalCount", "type": "integer", "required": true, "description": "入站IPv6总数", "example": "1" }, { "name": "EgressIPv4TotalCount", "type": "integer", "required": true, "description": "出站IPv4总数", "example": "1" }, { "name": "EgressIPv6TotalCount", "type": "integer", "required": true, "description": "出站IPv6总数", "example": "1" } ] } ] }, { "name": "SortPolicys", "type": "boolean", "required": false, "description": "排序安全组标识，默认值为False。当SortPolicys为False时，不改变安全组规则排序；当SortPolicys为True时，系统将严格按照SecurityGroupPolicySet参数传入的安全组规则及顺序进行重置，考虑到人为输入参数可能存在遗漏风险，建议通过控制台对安全组规则进行排序。", "example": "False" } ], "required": [ "SecurityGroupId", "SecurityGroupPolicySet" ] }, { "name": "ModifyServiceTemplateAttribute", "description": "本接口（ModifyServiceTemplateAttribute）用于修改协议端口模板。 \u003e?本接口为异步接口，可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果，待任务执行成功后再进行其他操作。 \u003e", "status": "online", "parameters": [ { "name": "ServiceTemplateId", "type": "string", "required": true, "description": "协议端口模板实例ID，例如：ppm-529nwwj8。", "example": "ppm-529nwwj8" }, { "name": "ServiceTemplateName", "type": "string", "required": false, "description": "协议端口模板名称。", "example": "demo" }, { "name": "Services", "type": "array", "required": false, "description": "支持单个端口、多个端口、连续端口及所有端口，协议支持：TCP、UDP、ICMP、GRE 协议。协议后面的端口部分长度不能超过128个字符。", "example": "[\"tcp:8080\"]", "item_type": "string" }, { "name": "ServicesExtra", "type": "array", "required": false, "description": "支持添加备注的协议端口信息，支持单个端口、多个端口、连续端口及所有端口，协议支持：TCP、UDP、ICMP、GRE 协议。", "example": "[{\"Service\": \"tcp:8080\", \"Description\": \"http service\"}]", "item_type": "object", "children": [ { "name": "Service", "type": "string", "required": true, "description": "协议端口。", "example": "tcp:80" }, { "name": "Description", "type": "string", "required": false, "description": "备注。", "example": "desc" }, { "name": "UpdatedTime", "type": "string", "required": false, "description": "更新时间。", "example": "2020-08-10 18:10:12" } ] } ], "required": [ "ServiceTemplateId" ] }, { "name": "ModifyServiceTemplateGroupAttribute", "description": "本接口（ModifyServiceTemplateGroupAttribute）用于修改协议端口模板集合。 \u003e?本接口为异步接口，可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果，待任务执行成功后再进行其他操作。 \u003e", "status": "online", "parameters": [ { "name": "ServiceTemplateGroupId", "type": "string", "required": true, "description": "协议端口模板集合实例ID，例如：ppmg-ei8hfd9a。", "example": "ppmg-p4oaqawq" }, { "name": "ServiceTemplateGroupName", "type": "string", "required": false, "description": "协议端口模板集合名称。", "example": "TEST" }, { "name": "ServiceTemplateIds", "type": "array", "required": false, "description": "协议端口模板实例ID，例如：ppm-4dw6agho。", "example": "['ppm-529nwwj8']", "item_type": "string" } ], "required": [ "ServiceTemplateGroupId" ] }, { "name": "ModifySnapshotPolicies", "description": "本接口（ModifySnapshotPolicies）用于修改快照策略。", "status": "online", "parameters": [ { "name": "SnapshotPoliciesInfo", "type": "array", "required": true, "description": "快照策略修改信息。", "example": "无", "item_type": "object", "children": [ { "name": "SnapshotPolicyId", "type": "string", "required": true, "description": "快照策略Id。", "example": "sspolicy-5k6fot41" }, { "name": "SnapshotPolicyName", "type": "string", "required": false, "description": "快照策略名称。", "example": "demo" }, { "name": "BackupPolicies", "type": "array", "required": false, "description": "备份策略。", "example": "[{\"SnapshotPolicyId\": \"sspolicy-5k6fot41\", \"SnapshotPolicyName\": \"demo\"}]", "item_type": "object", "children": [ { "name": "BackupDay", "type": "string", "required": true, "description": "备份周期时间，取值为monday, tuesday, wednesday, thursday, friday, saturday, sunday。", "example": "monday" }, { "name": "BackupTime", "type": "string", "required": true, "description": "备份时间点，格式：HH:mm:ss。", "example": "3:00" } ] }, { "name": "KeepTime", "type": "integer", "required": false, "description": "快照保留时间，支持1～365天。", "example": "12" } ] } ], "required": [ "SnapshotPoliciesInfo" ] }, { "name": "ModifySubnetAttribute", "description": "本接口（ModifySubnetAttribute）用于修改子网属性。", "status": "online", "parameters": [ { "name": "SubnetId", "type": "string", "required": true, "description": "子网实例ID。形如：subnet-pxir56ns。", "example": "subnet-test1234" }, { "name": "SubnetName", "type": "string", "required": false, "description": "子网名称，最大长度不能超过60个字节。", "example": "NewSubnetName" }, { "name": "EnableBroadcast", "type": "string", "required": false, "description": "子网是否开启广播。", "example": "true" } ], "required": [ "SubnetId" ] }, { "name": "ModifyTemplateMember", "description": "修改模板对象中的IP地址、协议端口、IP地址组、协议端口组。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "参数模板实例ID，支持IP地址、协议端口、IP地址组、协议端口组四种参数模板的实例ID。", "example": "ipm-nswq8wkq" }, { "name": "OriginalTemplateMember", "type": "array", "required": true, "description": "需要修改的参数模板成员信息，支持IP地址、协议端口、IP地址组、协议端口组四种类型，类型需要与TemplateId参数类型一致，修改顺序与TemplateMember参数顺序一一对应，入参长度需要与TemplateMember参数保持一致。", "example": "[{\"Member\": \"8.8.8.10\", \"Description\": \"office_2024-11-13_09:50:12\"}]", "item_type": "object", "children": [ { "name": "Member", "type": "string", "required": true, "description": "模板对象成员", "example": "ipm-h0fk8lfc" }, { "name": "Description", "type": "string", "required": false, "description": "模板对象成员描述信息", "example": "demo" } ] }, { "name": "TemplateMember", "type": "array", "required": true, "description": "新的参数模板成员信息，支持IP地址、协议端口、IP地址组、协议端口组四种类型，类型需要与TemplateId参数类型一致，修改顺序与OriginalTemplateMember参数顺序一一对应，入参长度需要与OriginalTemplateMember参数保持一致。", "example": "[{\"Member\": \"8.8.8.8\", \"Description\": \"demo\"}]", "item_type": "object", "children": [ { "name": "Member", "type": "string", "required": true, "description": "模板对象成员", "example": "ipm-h0fk8lfc" }, { "name": "Description", "type": "string", "required": false, "description": "模板对象成员描述信息", "example": "demo" } ] } ], "required": [ "TemplateId", "OriginalTemplateMember", "TemplateMember" ] }, { "name": "ModifyTrafficMirrorAttribute", "description": "本接口（ModifyTrafficMirrorAttribute）用于修改流量镜像实例属性。 注意：只支持修改名字和描述信息", "status": "online", "parameters": [ { "name": "TrafficMirrorId", "type": "string", "required": true, "description": "流量镜像实例ID", "example": "imgf-7h62jza4" }, { "name": "TrafficMirrorName", "type": "string", "required": false, "description": "流量镜像实例名称", "example": "demo" }, { "name": "TrafficMirrorDescription", "type": "string", "required": false, "description": "流量镜像实例描述信息", "example": "demo" } ], "required": [ "TrafficMirrorId" ] }, { "name": "ModifyVpcAttribute", "description": "本接口（ModifyVpcAttribute）用于修改私有网络（VPC）的相关属性。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC实例ID。形如：vpc-f49l6u0z。", "example": "vpc-m7sr81gh" }, { "name": "VpcName", "type": "string", "required": false, "description": "私有网络名称，可任意命名，但不得超过60个字符。", "example": "demo" }, { "name": "EnableMulticast", "type": "string", "required": false, "description": "是否开启组播。true: 开启, false: 关闭。", "example": "true" }, { "name": "DnsServers", "type": "array", "required": false, "description": "DNS地址，最多支持4个，第1个默认为主，其余为备。", "example": "[\"8.8.8.8\"]", "item_type": "string" }, { "name": "DomainName", "type": "string", "required": false, "description": "域名。", "example": "www.demo.com" }, { "name": "EnableRouteVpcPublish", "type": "boolean", "required": false, "description": "vpc关联云联网时路由发布策略， true：开启cidr路由发布，false：开启subnet子网路由发布。创建vpc时默认为子网路由发布，当选择cidr路由发布时,请通过工单加入白名单", "example": "true" }, { "name": "EnableCdcPublish", "type": "boolean", "required": false, "description": "发布cdc 子网到云联网的开关。true: 发布, false: 不发布。", "example": "false" }, { "name": "EnableRouteVpcPublishIpv6", "type": "boolean", "required": false, "description": "vpc关联云联网时IPv6类型路由发布策略， true：开启cidr路由发布，false：开启subnet子网路由发布。创建vpc时默认为子网路由发布，当选择cidr路由发布时，请通过工单加入白名单。", "example": "false" } ], "required": [ "VpcId" ] }, { "name": "ModifyVpcEndPointAttribute", "description": "本接口（ModifyVpcEndPointAttribute）用于修改终端节点属性。", "status": "online", "parameters": [ { "name": "EndPointId", "type": "string", "required": true, "description": "终端节点ID。可通过[DescribeVpcEndPoint](https://cloud.tencent.com/document/product/215/54679) 获取。", "example": "vpce-nswq8wkq" }, { "name": "EndPointName", "type": "string", "required": false, "description": "终端节点名称。长度限制为60个字符。", "example": "EndPointName1" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "安全组ID列表。可通过[DescribeSecurityGroups](https://cloud.tencent.com/document/product/215/15808)接口获取。", "example": "[\"sg-hj3he929\"]", "item_type": "string" }, { "name": "IpAddressType", "type": "string", "required": false, "description": "协议类型，支持 Ipv4，Ipv6，默认 Ipv4。", "example": "Ipv4" } ], "required": [ "EndPointId" ] }, { "name": "ModifyVpcEndPointServiceAttribute", "description": "本接口（ModifyVpcEndPointServiceAttribute）用于修改终端节点服务属性。", "status": "online", "parameters": [ { "name": "EndPointServiceId", "type": "string", "required": true, "description": "终端节点服务ID。可通过[DescribeVpcEndPointService](https://cloud.tencent.com/document/product/215/54678)接口获取。", "example": "vpces-hhth8n9j" }, { "name": "VpcId", "type": "string", "required": true, "description": "VPC唯一ID。可通过[DescribeVpcs](https://cloud.tencent.com/document/product/1108/43663)接口获取。", "example": "vpc-a2oj00df" }, { "name": "EndPointServiceName", "type": "string", "required": false, "description": "终端节点服务名称。长度不超过60个字符。", "example": "EndPointServiceName1" }, { "name": "AutoAcceptFlag", "type": "boolean", "required": false, "description": "是否自动接受终端节点的连接请求。true：自动接受false：不自动接受", "example": "false" }, { "name": "ServiceInstanceId", "type": "string", "required": false, "description": "后端服务的ID，比如lb-p1hiksdg。CLB可通过[DescribeLoadBalancers](https://cloud.tencent.com/document/product/1108/48459)接口获取； MYSQL可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/240/38568)接口获取； CRS可通过[DescribeInstances](https://cloud.tencent.com/document/product/239/20018)接口获取； GWLB可通过[DescribeGatewayLoadBalancers](https://cloud.tencent.com/document/product/1782/111683)接口获取", "example": "lb-75d88uw8" }, { "name": "IpAddressType", "type": "string", "required": false, "description": "协议类型，支持 Ipv4，Ipv6，默认 Ipv4。", "example": "Ipv4" } ], "required": [ "EndPointServiceId", "VpcId" ] }, { "name": "ModifyVpcEndPointServiceWhiteList", "description": "本接口（ModifyVpcEndPointServiceWhiteList）用于修改终端节点服务白名单属性。", "status": "online", "parameters": [ { "name": "UserUin", "type": "string", "required": true, "description": "用户UIN。可以通过终端节点所在的用户通过登录 腾讯云账号中心控制台获取。", "example": "700000483554" }, { "name": "EndPointServiceId", "type": "string", "required": true, "description": "终端节点服务ID。可通过[DescribeVpcEndPointService](https://cloud.tencent.com/document/product/215/54678)接口获取。", "example": "vpcsvc-b2mrmmx7" }, { "name": "Description", "type": "string", "required": false, "description": "白名单描述信息。长度不超过60个字符。", "example": "demo" } ], "required": [ "UserUin", "EndPointServiceId" ] }, { "name": "ModifyVpcPeeringConnection", "description": "本接口（ModifyVpcPeeringConnection）用于修改私有网络对等连接属性。", "status": "online", "parameters": [ { "name": "PeeringConnectionId", "type": "string", "required": true, "description": "对等连接ID。", "example": "pcx-0npfx81k" }, { "name": "PeeringConnectionName", "type": "string", "required": false, "description": "对等连接名称。", "example": "内部使用" }, { "name": "Bandwidth", "type": "integer", "required": false, "description": "带宽上限，单位Mbps。", "example": "10" }, { "name": "ChargeType", "type": "string", "required": false, "description": "计费模式，日峰值POSTPAID_BY_DAY_MAX，月95 POSTPAID_BY_MONTH_95。", "example": "POSTPAID_BY_DAY_MAX" } ], "required": [ "PeeringConnectionId" ] }, { "name": "ModifyVpnConnectionAttribute", "description": "本接口（ModifyVpnConnectionAttribute）用于修改VPN通道。", "status": "online", "parameters": [ { "name": "VpnConnectionId", "type": "string", "required": true, "description": "VPN通道实例ID。形如：vpnx-f49l6u0z。", "example": "vpnx-i0f4fo4m" }, { "name": "VpnConnectionName", "type": "string", "required": false, "description": "VPN通道名称，可任意命名，但不得超过60个字符。", "example": "new_name" }, { "name": "PreShareKey", "type": "string", "required": false, "description": "预共享密钥。", "example": "tencent" }, { "name": "SecurityPolicyDatabases", "type": "array", "required": false, "description": "SPD策略组，例如：{\"10.0.0.5/24\":[\"172.123.10.5/16\"]}，10.0.0.5/24是vpc内网段，172.123.10.5/16是IDC网段。用户指定VPC内哪些网段可以和您IDC中哪些网段通信。", "example": "无", "item_type": "object", "children": [ { "name": "LocalCidrBlock", "type": "string", "required": true, "description": "本端网段", "example": "10.40.1.12/24" }, { "name": "RemoteCidrBlock", "type": "array", "required": true, "description": "对端网段", "example": "['172.123.10.5/16', '10.7.10.0/16']", "item_type": "string" } ] }, { "name": "IKEOptionsSpecification", "type": "object", "required": false, "description": "IKE配置（Internet Key Exchange，因特网密钥交换），IKE具有一套自我保护机制，用户配置网络安全协议。", "example": "无", "children": [ { "name": "PropoEncryAlgorithm", "type": "string", "required": false, "description": "加密算法，可选值：'3DES-CBC', 'AES-CBC-128', 'AES-CBC-192', 'AES-CBC-256', 'DES-CBC'，'SM4', 默认为3DES-CBC", "example": "3DES-CBC" }, { "name": "PropoAuthenAlgorithm", "type": "string", "required": false, "description": "认证算法：可选值：'MD5'，'SHA'，'SHA-256'，'SHA-512'， 默认为SHA。", "example": "MD5" }, { "name": "ExchangeMode", "type": "string", "required": false, "description": "协商模式：可选值：'AGGRESSIVE'， 'MAIN'，默认为MAIN。", "example": "MAIN" }, { "name": "LocalIdentity", "type": "string", "required": false, "description": "本端标识类型：可选值：'ADDRESS', 'FQDN'，默认为ADDRESS", "example": "ADDRESS" }, { "name": "RemoteIdentity", "type": "string", "required": false, "description": "对端标识类型：可选值：'ADDRESS', 'FQDN'，默认为ADDRESS", "example": "ADDRESS" }, { "name": "LocalAddress", "type": "string", "required": false, "description": "本端标识，当LocalIdentity选为ADDRESS时，LocalAddress必填。localAddress默认为vpn网关公网IP", "example": "1.2.3.4" }, { "name": "RemoteAddress", "type": "string", "required": false, "description": "对端标识，当RemoteIdentity选为ADDRESS时，RemoteAddress必填", "example": "4.3.2.1" }, { "name": "LocalFqdnName", "type": "string", "required": false, "description": "本端标识，当LocalIdentity选为FQDN时，LocalFqdnName必填", "example": "LocalName" }, { "name": "RemoteFqdnName", "type": "string", "required": false, "description": "对端标识，当remoteIdentity选为FQDN时，RemoteFqdnName必填", "example": "RemoteName" }, { "name": "DhGroupName", "type": "string", "required": false, "description": "DH group，指定IKE交换密钥时使用的DH组，可选值：'GROUP1', 'GROUP2', 'GROUP5', 'GROUP14', 'GROUP24'，默认是GROUP1。", "example": "GROUP1" }, { "name": "IKESaLifetimeSeconds", "type": "integer", "required": false, "description": "IKE SA Lifetime，单位：秒，设置IKE SA的生存周期，取值范围：60-604800", "example": "60" }, { "name": "IKEVersion", "type": "string", "required": false, "description": "IKE版本", "example": "IKEV1" } ] }, { "name": "IPSECOptionsSpecification", "type": "object", "required": false, "description": "IPSec配置，腾讯云提供IPSec安全会话设置。", "example": "无", "children": [ { "name": "EncryptAlgorithm", "type": "string", "required": false, "description": "加密算法，可选值：'3DES-CBC', 'AES-CBC-128', 'AES-CBC-192', 'AES-CBC-256', 'DES-CBC', 'SM4', 'NULL'， 默认为AES-CBC-128", "example": "AES-CBC-128" }, { "name": "IPSECSaLifetimeSeconds", "type": "integer", "required": false, "description": "IPsec SA lifetime(s)：单位秒，取值范围：180-604800", "example": "180" }, { "name": "PfsDhGroup", "type": "string", "required": false, "description": "PFS：可选值：'NULL', 'DH-GROUP1', 'DH-GROUP2', 'DH-GROUP5', 'DH-GROUP14', 'DH-GROUP24'，默认为NULL", "example": "NULL" }, { "name": "IPSECSaLifetimeTraffic", "type": "integer", "required": false, "description": "IPsec SA lifetime(KB)：单位KB，取值范围：2560-604800", "example": "2560" }, { "name": "IntegrityAlgorithm", "type": "string", "required": false, "description": "认证算法：可选值：'MD5', 'SHA1'，'SHA-256' 默认为", "example": "SHA1" } ] }, { "name": "EnableHealthCheck", "type": "boolean", "required": false, "description": "是否启用通道健康检查，默认为False。", "example": "false" }, { "name": "HealthCheckLocalIp", "type": "string", "required": false, "description": "本端通道探测IP。", "example": "169.254.128.1" }, { "name": "HealthCheckRemoteIp", "type": "string", "required": false, "description": "对端通道探测IP。", "example": "169.254.128.2" }, { "name": "NegotiationType", "type": "string", "required": false, "description": "协商类型，默认为active（主动协商）。可选值：active（主动协商），passive（被动协商），flowTrigger（流量协商）", "example": "active" }, { "name": "DpdEnable", "type": "integer", "required": false, "description": "DPD探测开关。默认为0，表示关闭DPD探测。可选值：0（关闭），1（开启）", "example": "1" }, { "name": "DpdTimeout", "type": "string", "required": false, "description": "DPD超时时间。即探测确认对端不存在需要的时间。dpdEnable为1（开启）时有效。默认30，单位为秒", "example": "30" }, { "name": "DpdAction", "type": "string", "required": false, "description": "DPD超时后的动作。默认为clear。dpdEnable为1（开启）时有效。可取值为clear（断开）和restart（重试）", "example": "clear" }, { "name": "CustomerGatewayId", "type": "string", "required": false, "description": "对端网关ID，4.0及以上网关下的通道支持更新。", "example": "cgw-b6nlimbr" }, { "name": "HealthCheckConfig", "type": "object", "required": false, "description": "健康检查配置", "example": "无", "children": [ { "name": "ProbeType", "type": "string", "required": false, "description": "探测模式，默认值NQA，不可修改。", "example": "NQA" }, { "name": "ProbeInterval", "type": "integer", "required": false, "description": "探测间隔，腾讯云两次健康检查间隔时间，范围【1000-5000】，单位ms。", "example": "5000" }, { "name": "ProbeThreshold", "type": "integer", "required": false, "description": "探测次数，连续N次健康检查失败后执行路由切换，范围【3-8】，单位次。", "example": "3" }, { "name": "ProbeTimeout", "type": "integer", "required": false, "description": "探测超时时间，范围【10-5000】，单位ms。", "example": "150" } ] }, { "name": "BgpConfig", "type": "object", "required": false, "description": "BGP隧道配置", "example": "无", "children": [ { "name": "TunnelCidr", "type": "string", "required": true, "description": "BGP隧道网段。", "example": "169.254.128.0/30" }, { "name": "LocalBgpIp", "type": "string", "required": true, "description": "云端BGP地址。必须从BGP隧道网段内分配。", "example": "169.254.128.1" }, { "name": "RemoteBgpIp", "type": "string", "required": true, "description": "用户端BGP地址。必须从BGP隧道网段内分配。", "example": "169.254.128.2" } ] } ], "required": [ "VpnConnectionId" ] }, { "name": "ModifyVpnGatewayAttribute", "description": "本接口（ModifyVpnGatewayAttribute）用于修改VPN网关属性。", "status": "online", "parameters": [ { "name": "VpnGatewayId", "type": "string", "required": true, "description": "VPN网关实例ID。", "example": "vpngw-edvft32x" }, { "name": "VpnGatewayName", "type": "string", "required": false, "description": "VPN网关名称，最大长度不能超过60个字节。", "example": "test-vpn" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "VPN网关计费模式，目前只支持预付费（即包年包月）到后付费（即按量计费）的转换。即参数只支持：POSTPAID_BY_HOUR。", "example": "POSTPAID_BY_HOUR" }, { "name": "BgpAsn", "type": "integer", "required": false, "description": "BGP ASN。ASN取值范围为1- 4294967295，默认值64551，其中139341、45090和58835不可用。", "example": "0" }, { "name": "MaxConnection", "type": "integer", "required": false, "description": "服务端最大连接数个数。", "example": "10" } ], "required": [ "VpnGatewayId" ] }, { "name": "ModifyVpnGatewayCcnRoutes", "description": "本接口（ModifyVpnGatewayCcnRoutes）用于修改VPN网关云联网路由。", "status": "online", "parameters": [ { "name": "VpnGatewayId", "type": "string", "required": true, "description": "VPN网关实例ID。", "example": "vpngw-qol17bja" }, { "name": "Routes", "type": "array", "required": true, "description": "云联网路由（IDC网段）列表。其中RouteId可通过[DescribeVpnGatewayCcnRoutes](https://cloud.tencent.com/document/product/215/43514)接口获取。", "example": "[ { \"RouteId\": \"vpnr-66c7ihas\", \"Status\": \"ENABLE\", \"DestinationCidrBlock\": \"172.2.9.6/32\" } ]", "item_type": "object", "children": [ { "name": "RouteId", "type": "string", "required": true, "description": "路由信息ID。", "example": "vpnr-awda31c1" }, { "name": "Status", "type": "string", "required": false, "description": "路由信息是否启用。 ENABLE：启用该路由 DISABLE：不启用该路由", "example": "ENABLE" }, { "name": "DestinationCidrBlock", "type": "string", "required": false, "description": "路由CIDR。", "example": "10.0.0.0/16" } ] } ], "required": [ "VpnGatewayId", "Routes" ] }, { "name": "ModifyVpnGatewayRoutes", "description": "本接口（ModifyVpnGatewayRoutes）用于修改VPN路由是否启用。", "status": "online", "parameters": [ { "name": "VpnGatewayId", "type": "string", "required": true, "description": "VPN网关实例ID。", "example": "vpn-ngenl4az" }, { "name": "Routes", "type": "array", "required": true, "description": "路由修改参数。", "example": "无", "item_type": "object", "children": [ { "name": "RouteId", "type": "string", "required": true, "description": "VPN网关路由ID。", "example": "vpnr-u1c0cwe7" }, { "name": "Status", "type": "string", "required": false, "description": "VPN网关状态, ENABLE 启用, DISABLE禁用。", "example": "ENABLE" }, { "name": "Description", "type": "string", "required": false, "description": "VPN路由备注", "example": "route-1" } ] } ], "required": [ "VpnGatewayId", "Routes" ] }, { "name": "ModifyVpnGatewaySslClientCert", "description": "更新SslVpnClient证书", "status": "online", "parameters": [ { "name": "SslVpnClientIds", "type": "array", "required": true, "description": "SSL-VPN-CLIENT 实例ID列表。", "example": "[\"vpnc-2cpuxfh2\"]", "item_type": "string" } ], "required": [ "SslVpnClientIds" ] }, { "name": "ModifyVpnGatewaySslServer", "description": "本接口用于修改 SSL-VPN 服务端属性", "status": "online", "parameters": [ { "name": "SslVpnServerId", "type": "string", "required": true, "description": "SSL-VPN SERVER 实例ID", "example": "vpns-43eqlqex" }, { "name": "SslVpnServerName", "type": "string", "required": false, "description": "SSL-VPN SERVER NAME", "example": "rename-test" }, { "name": "LocalAddress", "type": "array", "required": false, "description": "本端地址", "example": "[\"10.0.0.0/24\"]", "item_type": "string" }, { "name": "RemoteAddress", "type": "string", "required": false, "description": "客户端地址", "example": "9.0.0.0/24" }, { "name": "SslVpnProtocol", "type": "string", "required": false, "description": "SSL VPN服务端监听协议。当前仅支持 UDP。默认UDP", "example": "UDP" }, { "name": "SslVpnPort", "type": "integer", "required": false, "description": "SSL VPN服务端监听协议端口。", "example": "1194" }, { "name": "EncryptAlgorithm", "type": "string", "required": false, "description": "加密算法。可选 'AES-128-CBC','AES-192-CBC', 'AES-256-CBC', 默认AES-128-CBC。", "example": "AES-128-CBC" }, { "name": "IntegrityAlgorithm", "type": "string", "required": false, "description": "认证算法。可选 'SHA1'，默认SHA1。", "example": "SHA1" }, { "name": "Compress", "type": "boolean", "required": false, "description": "是否支持压缩。当前不支持压缩。默认False。", "example": "false" }, { "name": "SsoEnabled", "type": "boolean", "required": false, "description": "是否开启SSO认证。默认为False。该功能当前需要申请开白使用。", "example": "false" }, { "name": "SamlData", "type": "string", "required": false, "description": "SAML-DATA", "example": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGlu" }, { "name": "DnsServers", "type": "object", "required": false, "description": "DNS Server地址", "example": "无", "children": [ { "name": "PrimaryDns", "type": "string", "required": false, "description": "主DNS配置", "example": "15.51.5.16" }, { "name": "SecondaryDns", "type": "string", "required": false, "description": "备DNS配置", "example": "15.51.67.1" } ] } ], "required": [ "SslVpnServerId" ] }, { "name": "NotifyRoutes", "description": "本接口（NotifyRoutes）用于路由表列表页操作增加“发布到云联网”，发布路由到云联网。", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表唯一ID。", "example": "rtb-9wzwlnhc" }, { "name": "RouteItemIds", "type": "array", "required": true, "description": "路由策略唯一ID。", "example": "[\"rti-i8bap903\\n\"]", "item_type": "string" } ], "required": [ "RouteTableId", "RouteItemIds" ] }, { "name": "RefreshDirectConnectGatewayRouteToNatGateway", "description": "刷新专线直连nat路由，更新nat到专线的路由表", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "vpc的ID", "example": "vpc-3m6kvgrx" }, { "name": "NatGatewayId", "type": "string", "required": true, "description": "NAT网关ID", "example": "nat-2jd1e1rm" }, { "name": "DryRun", "type": "boolean", "required": true, "description": "是否是预刷新；true:是， false:否", "example": "true" } ], "required": [ "VpcId", "NatGatewayId", "DryRun" ] }, { "name": "RejectAttachCcnInstances", "description": "本接口（RejectAttachCcnInstances）用于跨账号关联实例时，云联网所有者拒绝关联操作。", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "CCN实例ID。形如：ccn-f49l6u0z。", "example": "ccn-gree226l" }, { "name": "Instances", "type": "array", "required": true, "description": "拒绝关联实例列表。", "example": "无", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "关联实例ID。", "example": "vpc-lt6ork07" }, { "name": "InstanceRegion", "type": "string", "required": true, "description": "关联实例ID所属大区，例如：ap-guangzhou。", "example": "ap-guangzhou" }, { "name": "InstanceType", "type": "string", "required": true, "description": "关联实例类型，可选值： `VPC`：私有网络 `DIRECTCONNECT`：专线网关 `BMVPC`：黑石私有网络 `VPNGW`：VPNGW类型", "example": "VPC" }, { "name": "Description", "type": "string", "required": false, "description": "备注", "example": "remark" }, { "name": "RouteTableId", "type": "string", "required": false, "description": "实例关联的路由表ID。", "example": "ccnrtb-1234edfr" }, { "name": "OrderType", "type": "string", "required": false, "description": "实例付费方式", "example": "PayByCcnOwner" } ] } ], "required": [ "CcnId", "Instances" ] }, { "name": "RejectVpcPeeringConnection", "description": "本接口（RejectVpcPeeringConnection）用于驳回对等连接请求。", "status": "online", "parameters": [ { "name": "PeeringConnectionId", "type": "string", "required": true, "description": "对等连接唯一ID。", "example": " pcx-0npfx81k" } ], "required": [ "PeeringConnectionId" ] }, { "name": "ReleaseAddresses", "description": "本接口 (ReleaseAddresses) 用于释放一个或多个[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)（简称 EIP）。 * 该操作不可逆，释放后 EIP 关联的 IP 地址将不再属于您的名下。 * 只有状态为 UNBIND 的 EIP 才能进行释放操作。", "status": "online", "parameters": [ { "name": "AddressIds", "type": "array", "required": true, "description": "标识 EIP 的唯一 ID 列表。可以使用[DescribeAddresses](https://cloud.tencent.com/document/product/215/16702)接口获取AddressId。EIP 唯一 ID 形如：`eip-11112222`。", "example": "[\"eip-gzc5rgr2\"]", "item_type": "string" } ], "required": [ "AddressIds" ] }, { "name": "ReleaseIPv6Addresses", "description": "本接口（ReleaseIPv6Addresses）用于释放一个或多个弹性公网IPv6（简称EIPv6）实例。 - 支持对已申请到的弹性公网 IPv6 实例进行释放操作，如需再次使用，请重新申请。 - 只有状态为 UNBIND 的 EIPv6 实例才能进行释放操作。", "status": "online", "parameters": [ { "name": "IPv6AddressIds", "type": "array", "required": true, "description": "IPv6地址唯一ID。可以使用[DescribeIPv6Addresses](https://cloud.tencent.com/document/api/215/113677)接口获取IPv6AddressId。", "example": "[\"eipv6-bdwxghs1\"]", "item_type": "string" } ], "required": [ "IPv6AddressIds" ] }, { "name": "ReleaseIp6AddressesBandwidth", "description": "本接口（ReleaseIp6AddressesBandwidth）用于为传统弹性公网 IPv6 实例关闭 IPv6 公网带宽。 - 传统弹性公网 IPv6 实例关闭公网带宽后，仍具备 IPv6 内网通信能力。 - 如需再次开通 IPv6 公网带宽，请使用 [AllocateIp6AddressesBandwidth](https://cloud.tencent.com/document/product/215/40090) 接口进行开通。", "status": "online", "parameters": [ { "name": "Ip6Addresses", "type": "array", "required": false, "description": "IPv6地址。可以使用[DescribeIp6Addresses](https://cloud.tencent.com/document/product/215/40089)接口查询Ip6Addresses。Ip6Addresses和Ip6AddressIds必须且只能传一个。", "example": "[\"2402:4e00:1205:8c00:0:9835:2940:98d3\"]", "item_type": "string" }, { "name": "Ip6AddressIds", "type": "array", "required": false, "description": "IPv6地址对应的唯一ID，形如eip-xxxxxxxx。可以使用[DescribeIp6Addresses](https://cloud.tencent.com/document/product/215/40089)接口查询Ip6AddressIds。Ip6Addresses和Ip6AddressIds必须且只能传一个。", "example": "[\"eip-68dqs5ri\"]", "item_type": "string" } ], "required": [] }, { "name": "RemoveBandwidthPackageResources", "description": "接口用于删除带宽包资源，包括[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)和[负载均衡](https://cloud.tencent.com/document/product/214/517)等", "status": "online", "parameters": [ { "name": "ResourceIds", "type": "array", "required": false, "description": "资源唯一ID，当前支持EIP资源和LB资源，形如'eip-xxxx', 'lb-xxxx'。EIP资源列表可通过[DescribeAddresses](https://cloud.tencent.com/document/product/215/16702)接口获取，LB资源列表可通过[DescribeLoadBalancers](https://cloud.tencent.com/document/api/214/30685)接口获取。", "example": "[\"eip-alfxy9c8\"]", "item_type": "string" }, { "name": "BandwidthPackageId", "type": "string", "required": false, "description": "带宽包唯一标识ID，形如'bwp-xxxx'，可以使用[DescribeBandwidthPackages](https://cloud.tencent.com/document/product/215/19209)接口查询BandwidthPackageId。", "example": "bwp-pr0xbnvw" }, { "name": "ResourceType", "type": "string", "required": false, "description": "资源类型，可选值： Address：弹性公网IP LoadBalance：负载均衡", "example": "Address" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "用于移除带宽包内IP资源时指定IP的带宽值。说明：当前功能处于内测中，如需使用，请提交[工单申请](https://console.cloud.tencent.com/workorder/category)。", "example": "120" }, { "name": "InternetChargeType", "type": "string", "required": false, "description": "用于移除带宽包内IP资源时指定资源移除后的计费模式。小时流量：TRAFFIC_POSTPAID_BY_HOUR；小时带宽：BANDWIDTH_POSTPAID_BY_HOUR说明：当前功能处于内测中，如需使用，请提交[工单申请](https://console.cloud.tencent.com/workorder/category)。", "example": "TRAFFIC_POSTPAID_BY_HOUR" } ], "required": [] }, { "name": "RemoveIp6Rules", "description": "1. 该接口用于删除IPV6转换规则 2. 支持批量删除同一个转换实例下的多个转换规则", "status": "online", "parameters": [ { "name": "Ip6TranslatorId", "type": "string", "required": true, "description": "IPV6转换规则所属的转换实例唯一ID，形如ip6-xxxxxxxx", "example": "ip6-ma6nzj9n" }, { "name": "Ip6RuleIds", "type": "array", "required": true, "description": "待删除IPV6转换规则，形如rule6-xxxxxxxx", "example": "rule6-c1kjyfup", "item_type": "string" } ], "required": [ "Ip6TranslatorId", "Ip6RuleIds" ] }, { "name": "RenewAddresses", "description": "本接口（RenewAddresses）用于续费包月带宽计费模式的弹性公网IP。", "status": "online", "parameters": [ { "name": "AddressIds", "type": "array", "required": true, "description": "EIP唯一标识ID列表，形如'eip-xxxx'，可以使用[DescribeAddresses](https://cloud.tencent.com/document/product/215/16702)接口获取AddressId。", "example": "eip-59c7l00y", "item_type": "string" }, { "name": "AddressChargePrepaid", "type": "object", "required": true, "description": "续费参数", "example": "无", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位是月。可支持时长：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36", "example": "12" }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "自动续费标志。0表示手动续费，1表示自动续费，2表示到期不续费。默认缺省为1即自动续费。", "example": "2" } ] } ], "required": [ "AddressIds", "AddressChargePrepaid" ] }, { "name": "RenewVpnGateway", "description": "本接口（RenewVpnGateway）用于预付费（包年包月）VPN网关续费。目前只支持IPSEC网关。", "status": "online", "parameters": [ { "name": "VpnGatewayId", "type": "string", "required": true, "description": "VPN网关实例ID。", "example": "vpngw-cxkeaff3" }, { "name": "InstanceChargePrepaid", "type": "object", "required": true, "description": "预付费计费模式。", "example": "{ 'Period': 1, 'RenewFlag': 'NOTIFY_AND_MANUAL_RENEW' }", "children": [ { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36。", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费， NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费。默认：NOTIFY_AND_AUTO_RENEW", "example": "NOTIFY_AND_AUTO_RENEW" } ] } ], "required": [ "VpnGatewayId", "InstanceChargePrepaid" ] }, { "name": "ReplaceCcnRouteTableBroadcastPolicys", "description": "本接口(ReplaceCcnRouteTableBroadcastPolicys)用于替换云联网路由表路由传播策略。 \u003e 特别注意：是全量覆盖，非增量添加 **路由条件支持以下四种：** - 实例类型: `instance-type`，可选值：私有网络 `VPC`、专线网关 `DIRECTCONNECT`、VPN网关 `VPNGW` - 实例ID: `instance-id`，例如：`dcg-8zljkrft`、`vpc-jdevjrup`，暂不支持 `Edge` 实例 - 实例地域: `instance-region`，例如：`ap-guangzhou`产品支持的所有地域列表可通...", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "云联网ID", "example": "ccn-qd6z2ld1" }, { "name": "RouteTableId", "type": "string", "required": true, "description": "云联网路由表ID", "example": "ccnrtb-1mkezrkd" }, { "name": "Policys", "type": "array", "required": true, "description": "新的路由传播策略", "example": "无", "item_type": "object", "children": [ { "name": "RouteConditions", "type": "array", "required": true, "description": "路由条件", "example": "{'Name': 'instance-id', 'Values': ['DIRECTCONNECT'], 'MatchPattern': 1}", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "条件类型", "example": "instance-type" }, { "name": "Values", "type": "array", "required": true, "description": "条件值列表", "example": "['VPC', 'DIRECTCONNECT']", "item_type": "string" }, { "name": "MatchPattern", "type": "integer", "required": true, "description": "匹配模式，`1` 精确匹配，`0` 模糊匹配", "example": "1" } ] }, { "name": "BroadcastConditions", "type": "array", "required": true, "description": "传播条件", "example": "{'Name': 'instance-id', 'Values': ['DIRECTCONNECT'], 'MatchPattern': 1}", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "条件类型", "example": "instance-type" }, { "name": "Values", "type": "array", "required": true, "description": "条件值列表", "example": "['VPC', 'DIRECTCONNECT']", "item_type": "string" }, { "name": "MatchPattern", "type": "integer", "required": true, "description": "匹配模式，`1` 精确匹配，`0` 模糊匹配", "example": "1" } ] }, { "name": "Action", "type": "string", "required": true, "description": "路由行为，`accept` 允许，`drop` 拒绝", "example": "accept" }, { "name": "Description", "type": "string", "required": false, "description": "策略描述", "example": "接收指定关联实例路由" }, { "name": "OperateAsPath", "type": "string", "required": false, "description": "as-path操作", "example": "63551/63552" }, { "name": "AsPathOperateMode", "type": "string", "required": false, "description": "as-path操作模式", "example": "prepend" }, { "name": "OperateCommunitySet", "type": "array", "required": false, "description": "community操作", "example": "[\"65001:65001\"]", "item_type": "string" }, { "name": "CommunityOperateMode", "type": "string", "required": false, "description": "community操作模式", "example": "add" } ] } ], "required": [ "CcnId", "RouteTableId", "Policys" ] }, { "name": "ReplaceCcnRouteTableInputPolicys", "description": "本接口(ReplaceRouteTableInputPolicys)用于替换云联网路由表路由接收策略。 \u003e 特别注意：是全量覆盖，非增量添加 **路由条件支持以下四种：** - 实例类型: `instance-type`，可选值：私有网络 `VPC`、专线网关 `DIRECTCONNECT`、VPN网关 `VPNGW` - 实例ID: `instance-id`，例如：`dcg-8zljkrft`、`vpc-jdevjrup`，暂不支持 `Edge` 实例 - 实例地域: `instance-region`，例如：`ap-guangzhou`产品支持的所有地域列表可通过接\ufffd...", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "云联网ID。", "example": "ccn-qd6z2ld1" }, { "name": "RouteTableId", "type": "string", "required": true, "description": "云联网路由表ID。", "example": "ccnrtb-1mkezrkd" }, { "name": "Policys", "type": "array", "required": true, "description": "新的路由接收策略。", "example": "[{'routeConditions': [{'name': 'uniqInstanceIndex', 'valuevpc-8qxuno77']}], 'action': 'accept', 'description': '接收指定网络实例的路由'}]", "item_type": "object", "children": [ { "name": "RouteConditions", "type": "array", "required": true, "description": "路由条件。", "example": "[{\"matchPattern\": 0, \"values\": [\"65001/65002\"], \"name\": \"asPath\"}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "条件类型", "example": "instance-type" }, { "name": "Values", "type": "array", "required": true, "description": "条件值列表", "example": "['VPC', 'DIRECTCONNECT']", "item_type": "string" }, { "name": "MatchPattern", "type": "integer", "required": true, "description": "匹配模式，`1` 精确匹配，`0` 模糊匹配", "example": "1" } ] }, { "name": "Action", "type": "string", "required": true, "description": "路由行为，`accept` 允许，`drop` 拒绝。", "example": "accept" }, { "name": "Description", "type": "string", "required": true, "description": "策略描述。", "example": "接收指定关联实例路由" }, { "name": "OperateAsPath", "type": "string", "required": false, "description": "as-path操作", "example": "63551/63552" }, { "name": "AsPathOperateMode", "type": "string", "required": false, "description": "as-path操作模式", "example": "prepend" } ] } ], "required": [ "CcnId", "RouteTableId", "Policys" ] }, { "name": "ReplaceDirectConnectGatewayCcnRoutes", "description": "本接口（ReplaceDirectConnectGatewayCcnRoutes）根据路由ID（RouteId）修改指定的路由（Route），支持批量修改。", "status": "online", "parameters": [ { "name": "DirectConnectGatewayId", "type": "string", "required": true, "description": "专线网关ID，形如：dcg-prpqlmg1", "example": "dcg-xxxxxxxx" }, { "name": "Routes", "type": "array", "required": true, "description": "需要连通的IDC网段列表", "example": "[]", "item_type": "object", "children": [ { "name": "RouteId", "type": "string", "required": false, "description": "路由ID。", "example": "dcr-xxxxxxx" }, { "name": "DestinationCidrBlock", "type": "string", "required": false, "description": "IDC网段。", "example": "192.168.1.0/24" }, { "name": "ASPath", "type": "array", "required": false, "description": "`BGP`的`AS-Path`属性。", "example": "['2342', '342']", "item_type": "string" }, { "name": "Description", "type": "string", "required": false, "description": "备注", "example": "备注" }, { "name": "UpdateTime", "type": "string", "required": false, "description": "最后更新时间", "example": "2021-01-01 00:00:00" } ] }, { "name": "AddressType", "type": "string", "required": false, "description": "地址类型，支持：IPv4、IPv6。默认IPv4。", "example": "IPv4" } ], "required": [ "DirectConnectGatewayId", "Routes" ] }, { "name": "ReplaceHighPriorityRouteTableAssociation", "description": "替换高优路由表和子网绑定关系。", "status": "online", "parameters": [ { "name": "HighPriorityRouteTableId", "type": "string", "required": true, "description": "高优路由表唯一 ID。", "example": "hprtb-18mot1fm" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网唯一 ID。对于存在子网唯一ID的场景，该参数为必选。对于不存在子网ID的特殊场景，SubnetId和CidrBlock参数至少提供一个，二选一。", "example": "subnet-ie8choou" } ], "required": [ "HighPriorityRouteTableId" ] }, { "name": "ReplaceHighPriorityRoutes", "description": "替换高优路由表条目信息。", "status": "online", "parameters": [ { "name": "HighPriorityRouteTableId", "type": "string", "required": true, "description": "高优路由表唯一 ID。", "example": "hprtb-18mot1fm" }, { "name": "HighPriorityRoutes", "type": "array", "required": true, "description": "高优路由表条目信息。", "example": "无", "item_type": "object", "children": [ { "name": "HighPriorityRouteTableId", "type": "string", "required": false, "description": "高优路由表唯一 ID", "example": "hprtb-18mot1fm" }, { "name": "HighPriorityRouteId", "type": "string", "required": false, "description": "高优路由表条目唯一 ID", "example": "hprti-p1ymd0ak" }, { "name": "DestinationCidrBlock", "type": "string", "required": false, "description": "目标网段", "example": "172.20.0.0/16" }, { "name": "GatewayType", "type": "string", "required": false, "description": "网关类型", "example": "HAVIP" }, { "name": "GatewayId", "type": "string", "required": false, "description": "网关唯一ID", "example": "havip-mt4yhdps" }, { "name": "Description", "type": "string", "required": false, "description": "高优路由条目描述", "example": "test_high_priority_item" }, { "name": "SubnetRouteAlgorithm", "type": "string", "required": false, "description": "ECMP算法，支持的算法有：ECMP_QUINTUPLE_HASH：五元组hash，ECMP_SOURCE_DESTINATION_IP_HASH：源和目的IP hash，ECMP_DESTINATION_IP_HASH：目的IP hash，ECMP_SOURCE_IP_HASH：源IP hash。", "example": "ECMP_QUINTUPLE_HASH" }, { "name": "IsCdc", "type": "boolean", "required": false, "description": "出参展示，是否为CDC属性高优路由", "example": "true" }, { "name": "CdcId", "type": "string", "required": false, "description": "出参展示，CDC 唯一ID", "example": "cdc-hj3he929" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "创建时间。", "example": "2021-03-02 14:41:15" } ] } ], "required": [ "HighPriorityRouteTableId", "HighPriorityRoutes" ] }, { "name": "ReplaceRoutePolicyAssociations", "description": "本接口（ReplaceRoutePolicyAssociations）根据路由接收策略实例ID（RoutePolicyId）和路由表实例ID（RouteTableId）修改绑定优先级（Priority），支持批量修改。", "status": "online", "parameters": [ { "name": "RoutePolicyAssociationSet", "type": "array", "required": true, "description": "路由接收策略绑定对象列表。需要指定路由接收策略实例ID（RoutePolicyId）和路由表实例ID（RouteTableId）。", "example": "无", "item_type": "object", "children": [ { "name": "RouteTableId", "type": "string", "required": false, "description": "路由表唯一ID。", "example": "rtb-qk8eyn9g" }, { "name": "RoutePolicyId", "type": "string", "required": false, "description": "路由接收策略唯一ID。", "example": "rrp-r70ctaia" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级。", "example": "100" } ] } ], "required": [ "RoutePolicyAssociationSet" ] }, { "name": "ReplaceRoutePolicyEntries", "description": "本接口（ReplaceRoutePolicyEntries）根据路由接收策略规则ID（RoutePolicyEntryId）修改指定的路由策略条目（RoutePolicyEntry），支持批量修改。", "status": "online", "parameters": [ { "name": "RoutePolicyId", "type": "string", "required": true, "description": "路由策略实例ID，例如：rrp-azd4dt1c。", "example": "rrp-azd4dt1c" }, { "name": "RoutePolicyEntrySet", "type": "array", "required": true, "description": "路由策略规则列表。需要指定路由策略规则ID（RoutePolicyEntryId）。", "example": "无", "item_type": "object", "children": [ { "name": "RoutePolicyEntryId", "type": "string", "required": false, "description": "路由策略条目IPv4唯一ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "rrpi-hd7hsfhh" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "目标网段。 注意：此字段可能返回 null，表示取不到有效值。", "example": "13.0.0.0/16" }, { "name": "Description", "type": "string", "required": false, "description": "路由策略规则描述。 注意：此字段可能返回 null，表示取不到有效值。", "example": "demo" }, { "name": "RouteType", "type": "string", "required": false, "description": "路由类型。 USER：用户自定义类型。 NETD：网络探测下发的路由。 CCN：云联网路由。 注意：此字段可能返回 null，表示取不到有效值。", "example": "CCN" }, { "name": "GatewayType", "type": "string", "required": false, "description": "下一跳类型。目前我们支持的类型有： CVM：公网网关类型的云服务器； VPN：VPN网关； DIRECTCONNECT：专线网关； PEERCONNECTION：对等连接； HAVIP：高可用虚拟IP； NAT：NAT网关; EIP：云服务器的公网IP； LOCAL_GATEWAY：本地网关; PVGW：PVGW网关。 注意：此字段可能返回 null，表示取不到有效值。", "example": "CVM" }, { "name": "GatewayId", "type": "string", "required": false, "description": "网关唯一ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "172.16.16.37" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级。数值越小，优先级越高。 注意：此字段可能返回 null，表示取不到有效值。", "example": "100" }, { "name": "Action", "type": "string", "required": false, "description": "动作。 DROP：丢弃。 DISABLE：接收且禁用。 ACCEPT：接收且启用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ACCEPT" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "创建时间。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2023-05-20 15:06:34" }, { "name": "Region", "type": "string", "required": false, "description": "地域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-guangzhou" } ] } ], "required": [ "RoutePolicyId", "RoutePolicyEntrySet" ] }, { "name": "ReplaceRouteTableAssociation", "description": "本接口（ReplaceRouteTableAssociation）用于修改子网（Subnet）关联的路由表（RouteTable）。 * 一个子网只能关联一个路由表。", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表实例ID，例如：rtb-azd4dt1c。", "example": "rtb-azd4dt1c" }, { "name": "SubnetId", "type": "string", "required": false, "description": "子网实例ID，例如：subnet-3x5lf5q0。可通过DescribeSubnets接口查询。对于存在子网唯一ID的子网，该参数为必选；否则， SubnetId和CidrBlock必选二选一。", "example": "subnet-3x5lf5q0" } ], "required": [ "RouteTableId" ] }, { "name": "ReplaceRoutes", "description": "本接口（ReplaceRoutes）根据路由策略ID（RouteId）修改指定的路由策略（Route），支持批量修改。", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表实例ID，例如：rtb-azd4dt1c。", "example": "rtb-azd4dt1c" }, { "name": "Routes", "type": "array", "required": true, "description": "路由策略对象。需要指定路由策略ID（RouteId）。", "example": "无", "item_type": "object", "children": [ { "name": "DestinationCidrBlock", "type": "string", "required": true, "description": "创建IPv4目的网段，取值不能在私有网络网段内，例如：112.20.51.0/24。", "example": "10.0.0.0/24" }, { "name": "GatewayType", "type": "string", "required": true, "description": "下一跳类型，目前我们支持的类型有： CVM：公网网关类型的云服务器； VPN：VPN网关； DIRECTCONNECT：专线网关； PEERCONNECTION：对等连接； HAVIP：高可用虚拟IP； NAT：公网NAT网关; NORMAL_CVM：普通云服务器； EIP：云服务器的公网IP； LOCAL_GATEWAY：CDC本地网关； INTRANAT：私网NAT网关； USER_CCN：云联网（自定义路由）； GWLB_ENDPOINT：网关负载均衡终端节点。", "example": "CCN" }, { "name": "GatewayId", "type": "string", "required": true, "description": "下一跳地址，这里只需要指定不同下一跳类型的网关ID，系统会自动匹配到下一跳地址。 特殊说明： GatewayType为NORMAL_CVM时，GatewayId填写实例的内网IP。 GatewayType为EIP时，GatewayId填写0。", "example": "ccn-e187un9p" }, { "name": "RouteId", "type": "integer", "required": false, "description": "路由策略ID。IPv4路由策略ID是有意义的值，IPv6路由策略是无意义的值0。后续建议完全使用字符串唯一ID `RouteItemId`操作路由策略。 该字段在删除时必填，其他字段无需填写。", "example": "1289089" }, { "name": "RouteDescription", "type": "string", "required": false, "description": "路由策略描述。", "example": "demo" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否启用", "example": "true" }, { "name": "RouteType", "type": "string", "required": false, "description": "路由类型，目前我们支持的类型有： USER：用户路由； NETD：网络探测路由，创建网络探测实例时，系统默认下发，不可编辑与删除； CCN：云联网路由，系统默认下发，不可编辑与删除。 用户只能添加和操作 USER 类型的路由。", "example": "CCN" }, { "name": "RouteTableId", "type": "string", "required": false, "description": "路由表实例ID，例如：rtb-azd4dt1c。", "example": "rtb-azd4dt1c" }, { "name": "DestinationIpv6CidrBlock", "type": "string", "required": false, "description": "创建IPv6目的网段，取值不能在私有网络网段内，例如：2402:4e00:1000:810b::/64。", "example": "3402:4e00:20:1200::/56" }, { "name": "RouteItemId", "type": "string", "required": false, "description": "路由唯一策略ID。", "example": "rti-9bjer08h" }, { "name": "PublishedToVbc", "type": "boolean", "required": false, "description": "路由策略是否发布到云联网。该字段仅做出参使用，作为入参字段时此参数不生效。", "example": "true" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "路由策略创建时间", "example": "2021-03-02 14:41:15" }, { "name": "CdcId", "type": "string", "required": false, "description": "CDC 集群唯一 ID。", "example": "cluster-d8htgb6k" } ] } ], "required": [ "RouteTableId", "Routes" ] }, { "name": "ReplaceRoutesWithRoutePolicy", "description": "本接口（ReplaceRoutes）根据路由策略ID（RouteId）修改指定的路由策略（Route），支持批量修改。", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表实例ID。", "example": "rtb-65ckdx3a" }, { "name": "Routes", "type": "array", "required": true, "description": "路由策略对象。需要指定路由策略唯一ID（RouteItemId）。", "example": "无", "item_type": "object", "children": [ { "name": "RouteItemId", "type": "string", "required": false, "description": "路由唯一策略ID。", "example": "rti-g8jl2vll" }, { "name": "ForceMatchPolicy", "type": "boolean", "required": false, "description": "匹配路由接收策略标记。", "example": "true" } ] } ], "required": [ "RouteTableId", "Routes" ] }, { "name": "ReplaceSecurityGroupPolicies", "description": "本接口（ReplaceSecurityGroupPolicies）用于批量修改安全组规则（SecurityGroupPolicy）。 单个请求中只能替换单个方向的一条或多条规则, 必须要指定索引（PolicyIndex）。", "status": "online", "parameters": [ { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组实例ID，例如sg-33ocnj9n，可通过DescribeSecurityGroups获取。", "example": "sg-ohuuioma" }, { "name": "SecurityGroupPolicySet", "type": "object", "required": true, "description": "安全组规则集合对象。", "example": "无", "children": [ { "name": "Version", "type": "string", "required": false, "description": "安全组规则当前版本。用户每次更新安全规则版本会自动加1，防止更新的路由规则已过期，不填不考虑冲突。", "example": "10" }, { "name": "Egress", "type": "array", "required": false, "description": "出站规则。", "example": "[{\"PolicyIndex\": 0, \"Port\": \"443\", \"CidrBlock\": \"10.0.0.0/24\", \"Action\": \"ACCEPT\", \"ModifyTime\": \"2020-10-09 10:00:00\", \"PolicyDescription\": \"\", \"Protocol\": \"tcp\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号，值会随着安全组规则的变更动态变化。使用PolicyIndex时，请先调用`DescribeSecurityGroupPolicies`获取到规则的PolicyIndex，并且结合返回值中的Version一起使用处理规则。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP,ICMP,ICMPv6,ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。 说明：如果Protocol设置为ALL，则Port也需要设置为all。", "example": "22" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "ppm-8g7k5qfq", "children": [ { "name": "ServiceId", "type": "string", "required": false, "description": "协议端口ID，例如：ppm-f5n1f8da。", "example": "ppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": false, "description": "协议端口组ID，例如：ppmg-f5n1f8da。", "example": "ppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)，特殊说明：0.0.0.0/n 都会映射为0.0.0.0/0。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IP地址。", "example": "10.0.0.0/16" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IPv6地址。", "example": "::/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：sg-ohuuioma。", "example": "sg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者IP地址组ID。", "example": "ipm-p5sf61yj", "children": [ { "name": "AddressId", "type": "string", "required": false, "description": "IP地址ID，例如：ipm-2uw6ujo6。", "example": "ipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": false, "description": "IP地址组ID，例如：ipmg-2uw6ujo6。", "example": "ipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。作为入参时，当未传递该参数或值为空，且参数CidrBlock或Ipv6CidrBlock值为MY_PUBLIC_IP时，该参数的值将会被自动填充为Replaced-From-MY_PUBLIC_IP。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "安全组最近修改时间。", "example": "2021-03-02 14:41:15" }, { "name": "Priority", "type": "integer", "required": false, "description": "安全组规则优先级，值会随着安全组规则的变更动态变化。使用Priority时，请先调用`DescribeSecurityGroupPolicies`获取到规则的Priority，并且结合返回值中的Version一起使用处理规则。" } ] }, { "name": "Ingress", "type": "array", "required": false, "description": "入站规则。", "example": "[{\"PolicyIndex\": 0, \"Port\": \"443\", \"CidrBlock\": \"0.0.0.0/0\", \"Action\": \"ACCEPT\", \"ModifyTime\": \"2020-10-09 10:00:00\", \"PolicyDescription\": \"\", \"Protocol\": \"tcp\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号，值会随着安全组规则的变更动态变化。使用PolicyIndex时，请先调用`DescribeSecurityGroupPolicies`获取到规则的PolicyIndex，并且结合返回值中的Version一起使用处理规则。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP,ICMP,ICMPv6,ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。 说明：如果Protocol设置为ALL，则Port也需要设置为all。", "example": "22" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "ppm-8g7k5qfq", "children": [ { "name": "ServiceId", "type": "string", "required": false, "description": "协议端口ID，例如：ppm-f5n1f8da。", "example": "ppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": false, "description": "协议端口组ID，例如：ppmg-f5n1f8da。", "example": "ppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)，特殊说明：0.0.0.0/n 都会映射为0.0.0.0/0。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IP地址。", "example": "10.0.0.0/16" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IPv6地址。", "example": "::/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：sg-ohuuioma。", "example": "sg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者IP地址组ID。", "example": "ipm-p5sf61yj", "children": [ { "name": "AddressId", "type": "string", "required": false, "description": "IP地址ID，例如：ipm-2uw6ujo6。", "example": "ipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": false, "description": "IP地址组ID，例如：ipmg-2uw6ujo6。", "example": "ipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。作为入参时，当未传递该参数或值为空，且参数CidrBlock或Ipv6CidrBlock值为MY_PUBLIC_IP时，该参数的值将会被自动填充为Replaced-From-MY_PUBLIC_IP。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "安全组最近修改时间。", "example": "2021-03-02 14:41:15" }, { "name": "Priority", "type": "integer", "required": false, "description": "安全组规则优先级，值会随着安全组规则的变更动态变化。使用Priority时，请先调用`DescribeSecurityGroupPolicies`获取到规则的Priority，并且结合返回值中的Version一起使用处理规则。" } ] }, { "name": "PolicyStatistics", "type": "object", "required": false, "description": "安全组策略条目统计。只用于出参。", "example": "{\"IngressIPv4TotalCount\": 1, \"IngressIPv6TotalCount\": 0, \"EgressIPv4TotalCount\": 1, \"EgressIPv6TotalCount\": 0}", "children": [ { "name": "IngressIPv4TotalCount", "type": "integer", "required": true, "description": "入站IPv4总数", "example": "1" }, { "name": "IngressIPv6TotalCount", "type": "integer", "required": true, "description": "入站IPv6总数", "example": "1" }, { "name": "EgressIPv4TotalCount", "type": "integer", "required": true, "description": "出站IPv4总数", "example": "1" }, { "name": "EgressIPv6TotalCount", "type": "integer", "required": true, "description": "出站IPv6总数", "example": "1" } ] } ] }, { "name": "OriginalSecurityGroupPolicySet", "type": "object", "required": false, "description": "旧的安全组规则集合对象，当更新优先级时为必选，且修改顺序与SecurityGroupPolicySet参数顺序一一对应，入参长度需要与SecurityGroupPolicySet参数保持一致。", "example": "无", "children": [ { "name": "Version", "type": "string", "required": false, "description": "安全组规则当前版本。用户每次更新安全规则版本会自动加1，防止更新的路由规则已过期，不填不考虑冲突。", "example": "10" }, { "name": "Egress", "type": "array", "required": false, "description": "出站规则。", "example": "[{\"PolicyIndex\": 0, \"Port\": \"443\", \"CidrBlock\": \"10.0.0.0/24\", \"Action\": \"ACCEPT\", \"ModifyTime\": \"2020-10-09 10:00:00\", \"PolicyDescription\": \"\", \"Protocol\": \"tcp\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号，值会随着安全组规则的变更动态变化。使用PolicyIndex时，请先调用`DescribeSecurityGroupPolicies`获取到规则的PolicyIndex，并且结合返回值中的Version一起使用处理规则。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP,ICMP,ICMPv6,ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。 说明：如果Protocol设置为ALL，则Port也需要设置为all。", "example": "22" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "ppm-8g7k5qfq", "children": [ { "name": "ServiceId", "type": "string", "required": false, "description": "协议端口ID，例如：ppm-f5n1f8da。", "example": "ppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": false, "description": "协议端口组ID，例如：ppmg-f5n1f8da。", "example": "ppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)，特殊说明：0.0.0.0/n 都会映射为0.0.0.0/0。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IP地址。", "example": "10.0.0.0/16" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IPv6地址。", "example": "::/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：sg-ohuuioma。", "example": "sg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者IP地址组ID。", "example": "ipm-p5sf61yj", "children": [ { "name": "AddressId", "type": "string", "required": false, "description": "IP地址ID，例如：ipm-2uw6ujo6。", "example": "ipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": false, "description": "IP地址组ID，例如：ipmg-2uw6ujo6。", "example": "ipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。作为入参时，当未传递该参数或值为空，且参数CidrBlock或Ipv6CidrBlock值为MY_PUBLIC_IP时，该参数的值将会被自动填充为Replaced-From-MY_PUBLIC_IP。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "安全组最近修改时间。", "example": "2021-03-02 14:41:15" }, { "name": "Priority", "type": "integer", "required": false, "description": "安全组规则优先级，值会随着安全组规则的变更动态变化。使用Priority时，请先调用`DescribeSecurityGroupPolicies`获取到规则的Priority，并且结合返回值中的Version一起使用处理规则。" } ] }, { "name": "Ingress", "type": "array", "required": false, "description": "入站规则。", "example": "[{\"PolicyIndex\": 0, \"Port\": \"443\", \"CidrBlock\": \"0.0.0.0/0\", \"Action\": \"ACCEPT\", \"ModifyTime\": \"2020-10-09 10:00:00\", \"PolicyDescription\": \"\", \"Protocol\": \"tcp\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号，值会随着安全组规则的变更动态变化。使用PolicyIndex时，请先调用`DescribeSecurityGroupPolicies`获取到规则的PolicyIndex，并且结合返回值中的Version一起使用处理规则。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP,ICMP,ICMPv6,ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。 说明：如果Protocol设置为ALL，则Port也需要设置为all。", "example": "22" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "ppm-8g7k5qfq", "children": [ { "name": "ServiceId", "type": "string", "required": false, "description": "协议端口ID，例如：ppm-f5n1f8da。", "example": "ppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": false, "description": "协议端口组ID，例如：ppmg-f5n1f8da。", "example": "ppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)，特殊说明：0.0.0.0/n 都会映射为0.0.0.0/0。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IP地址。", "example": "10.0.0.0/16" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IPv6地址。", "example": "::/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：sg-ohuuioma。", "example": "sg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者IP地址组ID。", "example": "ipm-p5sf61yj", "children": [ { "name": "AddressId", "type": "string", "required": false, "description": "IP地址ID，例如：ipm-2uw6ujo6。", "example": "ipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": false, "description": "IP地址组ID，例如：ipmg-2uw6ujo6。", "example": "ipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。作为入参时，当未传递该参数或值为空，且参数CidrBlock或Ipv6CidrBlock值为MY_PUBLIC_IP时，该参数的值将会被自动填充为Replaced-From-MY_PUBLIC_IP。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "安全组最近修改时间。", "example": "2021-03-02 14:41:15" }, { "name": "Priority", "type": "integer", "required": false, "description": "安全组规则优先级，值会随着安全组规则的变更动态变化。使用Priority时，请先调用`DescribeSecurityGroupPolicies`获取到规则的Priority，并且结合返回值中的Version一起使用处理规则。" } ] }, { "name": "PolicyStatistics", "type": "object", "required": false, "description": "安全组策略条目统计。只用于出参。", "example": "{\"IngressIPv4TotalCount\": 1, \"IngressIPv6TotalCount\": 0, \"EgressIPv4TotalCount\": 1, \"EgressIPv6TotalCount\": 0}", "children": [ { "name": "IngressIPv4TotalCount", "type": "integer", "required": true, "description": "入站IPv4总数", "example": "1" }, { "name": "IngressIPv6TotalCount", "type": "integer", "required": true, "description": "入站IPv6总数", "example": "1" }, { "name": "EgressIPv4TotalCount", "type": "integer", "required": true, "description": "出站IPv4总数", "example": "1" }, { "name": "EgressIPv6TotalCount", "type": "integer", "required": true, "description": "出站IPv6总数", "example": "1" } ] } ] }, { "name": "UpdateType", "type": "string", "required": false, "description": "更新类型，默认 Policy Policy：只更新内容 Priority：只更新优先级 Both：内容和优先级都更新", "example": "Policy" } ], "required": [ "SecurityGroupId", "SecurityGroupPolicySet" ] }, { "name": "ReplaceSecurityGroupPolicy", "description": "本接口（ReplaceSecurityGroupPolicy）用于替换单条安全组规则（SecurityGroupPolicy）。 单个请求中只能替换单个方向的一条规则, 必须要指定索引（PolicyIndex）。", "status": "online", "parameters": [ { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组实例ID，例如sg-33ocnj9n，可通过DescribeSecurityGroups获取。", "example": "sg-ohuuioma" }, { "name": "SecurityGroupPolicySet", "type": "object", "required": true, "description": "安全组规则集合对象。", "example": "{\"Ingress\": [{\"Action\": \"ACCEPT\", \"CidrBlock\": \"10.0.0.0/16\", \"PolicyDescription\": \"\", \"PolicyIndex\": \"0\", \"Port\": \"443\", \"Protocol\": \"TCP\"}], \"Version\": \"1\"}", "children": [ { "name": "Version", "type": "string", "required": false, "description": "安全组规则当前版本。用户每次更新安全规则版本会自动加1，防止更新的路由规则已过期，不填不考虑冲突。", "example": "10" }, { "name": "Egress", "type": "array", "required": false, "description": "出站规则。", "example": "[{\"PolicyIndex\": 0, \"Port\": \"443\", \"CidrBlock\": \"10.0.0.0/24\", \"Action\": \"ACCEPT\", \"ModifyTime\": \"2020-10-09 10:00:00\", \"PolicyDescription\": \"\", \"Protocol\": \"tcp\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号，值会随着安全组规则的变更动态变化。使用PolicyIndex时，请先调用`DescribeSecurityGroupPolicies`获取到规则的PolicyIndex，并且结合返回值中的Version一起使用处理规则。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP,ICMP,ICMPv6,ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。 说明：如果Protocol设置为ALL，则Port也需要设置为all。", "example": "22" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "ppm-8g7k5qfq", "children": [ { "name": "ServiceId", "type": "string", "required": false, "description": "协议端口ID，例如：ppm-f5n1f8da。", "example": "ppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": false, "description": "协议端口组ID，例如：ppmg-f5n1f8da。", "example": "ppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)，特殊说明：0.0.0.0/n 都会映射为0.0.0.0/0。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IP地址。", "example": "10.0.0.0/16" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IPv6地址。", "example": "::/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：sg-ohuuioma。", "example": "sg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者IP地址组ID。", "example": "ipm-p5sf61yj", "children": [ { "name": "AddressId", "type": "string", "required": false, "description": "IP地址ID，例如：ipm-2uw6ujo6。", "example": "ipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": false, "description": "IP地址组ID，例如：ipmg-2uw6ujo6。", "example": "ipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。作为入参时，当未传递该参数或值为空，且参数CidrBlock或Ipv6CidrBlock值为MY_PUBLIC_IP时，该参数的值将会被自动填充为Replaced-From-MY_PUBLIC_IP。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "安全组最近修改时间。", "example": "2021-03-02 14:41:15" }, { "name": "Priority", "type": "integer", "required": false, "description": "安全组规则优先级，值会随着安全组规则的变更动态变化。使用Priority时，请先调用`DescribeSecurityGroupPolicies`获取到规则的Priority，并且结合返回值中的Version一起使用处理规则。" } ] }, { "name": "Ingress", "type": "array", "required": false, "description": "入站规则。", "example": "[{\"PolicyIndex\": 0, \"Port\": \"443\", \"CidrBlock\": \"0.0.0.0/0\", \"Action\": \"ACCEPT\", \"ModifyTime\": \"2020-10-09 10:00:00\", \"PolicyDescription\": \"\", \"Protocol\": \"tcp\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号，值会随着安全组规则的变更动态变化。使用PolicyIndex时，请先调用`DescribeSecurityGroupPolicies`获取到规则的PolicyIndex，并且结合返回值中的Version一起使用处理规则。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP,ICMP,ICMPv6,ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。 说明：如果Protocol设置为ALL，则Port也需要设置为all。", "example": "22" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "ppm-8g7k5qfq", "children": [ { "name": "ServiceId", "type": "string", "required": false, "description": "协议端口ID，例如：ppm-f5n1f8da。", "example": "ppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": false, "description": "协议端口组ID，例如：ppmg-f5n1f8da。", "example": "ppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)，特殊说明：0.0.0.0/n 都会映射为0.0.0.0/0。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IP地址。", "example": "10.0.0.0/16" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IPv6地址。", "example": "::/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：sg-ohuuioma。", "example": "sg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者IP地址组ID。", "example": "ipm-p5sf61yj", "children": [ { "name": "AddressId", "type": "string", "required": false, "description": "IP地址ID，例如：ipm-2uw6ujo6。", "example": "ipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": false, "description": "IP地址组ID，例如：ipmg-2uw6ujo6。", "example": "ipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。作为入参时，当未传递该参数或值为空，且参数CidrBlock或Ipv6CidrBlock值为MY_PUBLIC_IP时，该参数的值将会被自动填充为Replaced-From-MY_PUBLIC_IP。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "安全组最近修改时间。", "example": "2021-03-02 14:41:15" }, { "name": "Priority", "type": "integer", "required": false, "description": "安全组规则优先级，值会随着安全组规则的变更动态变化。使用Priority时，请先调用`DescribeSecurityGroupPolicies`获取到规则的Priority，并且结合返回值中的Version一起使用处理规则。" } ] }, { "name": "PolicyStatistics", "type": "object", "required": false, "description": "安全组策略条目统计。只用于出参。", "example": "{\"IngressIPv4TotalCount\": 1, \"IngressIPv6TotalCount\": 0, \"EgressIPv4TotalCount\": 1, \"EgressIPv6TotalCount\": 0}", "children": [ { "name": "IngressIPv4TotalCount", "type": "integer", "required": true, "description": "入站IPv4总数", "example": "1" }, { "name": "IngressIPv6TotalCount", "type": "integer", "required": true, "description": "入站IPv6总数", "example": "1" }, { "name": "EgressIPv4TotalCount", "type": "integer", "required": true, "description": "出站IPv4总数", "example": "1" }, { "name": "EgressIPv6TotalCount", "type": "integer", "required": true, "description": "出站IPv6总数", "example": "1" } ] } ] }, { "name": "OriginalSecurityGroupPolicySet", "type": "object", "required": false, "description": "旧的安全组规则集合对象，可选，日志记录用。", "example": "{\"Ingress\": [{\"Action\": \"ACCEPT\", \"CidrBlock\": \"10.0.0.0/16\", \"ModifyTime\": \"2020-11-13 10:35:07\", \"PolicyIndex\": \"0\", \"Port\": \"80\", \"Protocol\": \"tcp\"}], \"Version\": \"1\"}", "children": [ { "name": "Version", "type": "string", "required": false, "description": "安全组规则当前版本。用户每次更新安全规则版本会自动加1，防止更新的路由规则已过期，不填不考虑冲突。", "example": "10" }, { "name": "Egress", "type": "array", "required": false, "description": "出站规则。", "example": "[{\"PolicyIndex\": 0, \"Port\": \"443\", \"CidrBlock\": \"10.0.0.0/24\", \"Action\": \"ACCEPT\", \"ModifyTime\": \"2020-10-09 10:00:00\", \"PolicyDescription\": \"\", \"Protocol\": \"tcp\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号，值会随着安全组规则的变更动态变化。使用PolicyIndex时，请先调用`DescribeSecurityGroupPolicies`获取到规则的PolicyIndex，并且结合返回值中的Version一起使用处理规则。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP,ICMP,ICMPv6,ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。 说明：如果Protocol设置为ALL，则Port也需要设置为all。", "example": "22" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "ppm-8g7k5qfq", "children": [ { "name": "ServiceId", "type": "string", "required": false, "description": "协议端口ID，例如：ppm-f5n1f8da。", "example": "ppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": false, "description": "协议端口组ID，例如：ppmg-f5n1f8da。", "example": "ppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)，特殊说明：0.0.0.0/n 都会映射为0.0.0.0/0。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IP地址。", "example": "10.0.0.0/16" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IPv6地址。", "example": "::/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：sg-ohuuioma。", "example": "sg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者IP地址组ID。", "example": "ipm-p5sf61yj", "children": [ { "name": "AddressId", "type": "string", "required": false, "description": "IP地址ID，例如：ipm-2uw6ujo6。", "example": "ipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": false, "description": "IP地址组ID，例如：ipmg-2uw6ujo6。", "example": "ipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。作为入参时，当未传递该参数或值为空，且参数CidrBlock或Ipv6CidrBlock值为MY_PUBLIC_IP时，该参数的值将会被自动填充为Replaced-From-MY_PUBLIC_IP。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "安全组最近修改时间。", "example": "2021-03-02 14:41:15" }, { "name": "Priority", "type": "integer", "required": false, "description": "安全组规则优先级，值会随着安全组规则的变更动态变化。使用Priority时，请先调用`DescribeSecurityGroupPolicies`获取到规则的Priority，并且结合返回值中的Version一起使用处理规则。" } ] }, { "name": "Ingress", "type": "array", "required": false, "description": "入站规则。", "example": "[{\"PolicyIndex\": 0, \"Port\": \"443\", \"CidrBlock\": \"0.0.0.0/0\", \"Action\": \"ACCEPT\", \"ModifyTime\": \"2020-10-09 10:00:00\", \"PolicyDescription\": \"\", \"Protocol\": \"tcp\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号，值会随着安全组规则的变更动态变化。使用PolicyIndex时，请先调用`DescribeSecurityGroupPolicies`获取到规则的PolicyIndex，并且结合返回值中的Version一起使用处理规则。", "example": "0" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP,ICMP,ICMPv6,ALL。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。 说明：如果Protocol设置为ALL，则Port也需要设置为all。", "example": "22" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "ppm-8g7k5qfq", "children": [ { "name": "ServiceId", "type": "string", "required": false, "description": "协议端口ID，例如：ppm-f5n1f8da。", "example": "ppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": false, "description": "协议端口组ID，例如：ppmg-f5n1f8da。", "example": "ppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)，特殊说明：0.0.0.0/n 都会映射为0.0.0.0/0。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IP地址。", "example": "10.0.0.0/16" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。作为入参时，可使用字符串`MY_PUBLIC_IP`指代发起请求的公网IPv6地址。", "example": "::/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：sg-ohuuioma。", "example": "sg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者IP地址组ID。", "example": "ipm-p5sf61yj", "children": [ { "name": "AddressId", "type": "string", "required": false, "description": "IP地址ID，例如：ipm-2uw6ujo6。", "example": "ipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": false, "description": "IP地址组ID，例如：ipmg-2uw6ujo6。", "example": "ipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。作为入参时，当未传递该参数或值为空，且参数CidrBlock或Ipv6CidrBlock值为MY_PUBLIC_IP时，该参数的值将会被自动填充为Replaced-From-MY_PUBLIC_IP。", "example": "demo" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "安全组最近修改时间。", "example": "2021-03-02 14:41:15" }, { "name": "Priority", "type": "integer", "required": false, "description": "安全组规则优先级，值会随着安全组规则的变更动态变化。使用Priority时，请先调用`DescribeSecurityGroupPolicies`获取到规则的Priority，并且结合返回值中的Version一起使用处理规则。" } ] }, { "name": "PolicyStatistics", "type": "object", "required": false, "description": "安全组策略条目统计。只用于出参。", "example": "{\"IngressIPv4TotalCount\": 1, \"IngressIPv6TotalCount\": 0, \"EgressIPv4TotalCount\": 1, \"EgressIPv6TotalCount\": 0}", "children": [ { "name": "IngressIPv4TotalCount", "type": "integer", "required": true, "description": "入站IPv4总数", "example": "1" }, { "name": "IngressIPv6TotalCount", "type": "integer", "required": true, "description": "入站IPv6总数", "example": "1" }, { "name": "EgressIPv4TotalCount", "type": "integer", "required": true, "description": "出站IPv4总数", "example": "1" }, { "name": "EgressIPv6TotalCount", "type": "integer", "required": true, "description": "出站IPv6总数", "example": "1" } ] } ] } ], "required": [ "SecurityGroupId", "SecurityGroupPolicySet" ] }, { "name": "ResetAttachCcnInstances", "description": "本接口（ResetAttachCcnInstances）用于跨账号关联实例申请过期时，重新申请关联操作。", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "CCN实例ID。形如：ccn-f49l6u0z。", "example": "ccn-gree226l" }, { "name": "CcnUin", "type": "string", "required": true, "description": "CCN所属UIN（根账号）。", "example": "979137" }, { "name": "Instances", "type": "array", "required": true, "description": "重新申请关联网络实例列表。", "example": "无", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "关联实例ID。", "example": "vpc-lt6ork07" }, { "name": "InstanceRegion", "type": "string", "required": true, "description": "关联实例ID所属大区，例如：ap-guangzhou。", "example": "ap-guangzhou" }, { "name": "InstanceType", "type": "string", "required": true, "description": "关联实例类型，可选值： `VPC`：私有网络 `DIRECTCONNECT`：专线网关 `BMVPC`：黑石私有网络 `VPNGW`：VPNGW类型", "example": "VPC" }, { "name": "Description", "type": "string", "required": false, "description": "备注", "example": "remark" }, { "name": "RouteTableId", "type": "string", "required": false, "description": "实例关联的路由表ID。", "example": "ccnrtb-1234edfr" }, { "name": "OrderType", "type": "string", "required": false, "description": "实例付费方式", "example": "PayByCcnOwner" } ] } ], "required": [ "CcnId", "CcnUin", "Instances" ] }, { "name": "ResetHighPriorityRoutes", "description": "重置高优路由表。", "status": "online", "parameters": [ { "name": "HighPriorityRouteTableId", "type": "string", "required": true, "description": "高优路由表唯一 ID。", "example": "hprtb-18mot1fm" }, { "name": "Name", "type": "string", "required": true, "description": "高优路由表名称。", "example": "demo" }, { "name": "HighPriorityRoutes", "type": "array", "required": true, "description": "高优路由表条目信息。", "example": "[{\"DestinationCidrBlock\": \"172.25.0.0/16\", \"Description\": \"demo\", \"Enabled\": false, \"GatewayType\": \"NORMAL_CVM\", \"GatewayId\": \"172.16.0.11\", \"SubnetRouteAlgorithm\": \"ECMP_SOURCE_IP_HASH\"}]", "item_type": "object", "children": [ { "name": "HighPriorityRouteTableId", "type": "string", "required": false, "description": "高优路由表唯一 ID", "example": "hprtb-18mot1fm" }, { "name": "HighPriorityRouteId", "type": "string", "required": false, "description": "高优路由表条目唯一 ID", "example": "hprti-p1ymd0ak" }, { "name": "DestinationCidrBlock", "type": "string", "required": false, "description": "目标网段", "example": "172.20.0.0/16" }, { "name": "GatewayType", "type": "string", "required": false, "description": "网关类型", "example": "HAVIP" }, { "name": "GatewayId", "type": "string", "required": false, "description": "网关唯一ID", "example": "havip-mt4yhdps" }, { "name": "Description", "type": "string", "required": false, "description": "高优路由条目描述", "example": "test_high_priority_item" }, { "name": "SubnetRouteAlgorithm", "type": "string", "required": false, "description": "ECMP算法，支持的算法有：ECMP_QUINTUPLE_HASH：五元组hash，ECMP_SOURCE_DESTINATION_IP_HASH：源和目的IP hash，ECMP_DESTINATION_IP_HASH：目的IP hash，ECMP_SOURCE_IP_HASH：源IP hash。", "example": "ECMP_QUINTUPLE_HASH" }, { "name": "IsCdc", "type": "boolean", "required": false, "description": "出参展示，是否为CDC属性高优路由", "example": "true" }, { "name": "CdcId", "type": "string", "required": false, "description": "出参展示，CDC 唯一ID", "example": "cdc-hj3he929" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "创建时间。", "example": "2021-03-02 14:41:15" } ] } ], "required": [ "HighPriorityRouteTableId", "Name", "HighPriorityRoutes" ] }, { "name": "ResetNatGatewayConnection", "description": "本接口（ResetNatGatewayConnection）用于调整传统型NAT网关并发连接数上限。", "status": "online", "parameters": [ { "name": "NatGatewayId", "type": "string", "required": true, "description": "NAT网关ID。", "example": "nat-ig8xpno8" }, { "name": "MaxConcurrentConnection", "type": "integer", "required": true, "description": "NAT网关并发连接上限，形如：1000000、3000000、10000000。", "example": "3000000" }, { "name": "ExclusiveType", "type": "string", "required": false, "description": "独享实例规格。如果要变配到独享实例，此参数必选，取值范围：ExclusiveSmall/ExclusiveMedium1/ExclusiveLarge1", "example": "ExclusiveLarge1" } ], "required": [ "NatGatewayId", "MaxConcurrentConnection" ] }, { "name": "ResetRoutePolicyAssociations", "description": "本接口（ResetRoutePolicyAssociations）用于对某个路由表实例已经绑定的路由策略实例解除绑定关系，并重新设置新的绑定路由策略及优先级。", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表实例ID，例如：rtb-azd4dt1c。", "example": "rtb-n0yejvje" }, { "name": "RoutePolicyAssociationSet", "type": "array", "required": true, "description": "路由策略绑定对象（RoutePolicyAssociation）列表。注意：路由策略绑定中的路由表实例ID（RouteTableId）需要和该接口的RouteTableId参数保持一致（也就是该接口只支持修改同一个路由表实例下的路有策略绑定关系及优先级）。", "example": "无", "item_type": "object", "children": [ { "name": "RouteTableId", "type": "string", "required": false, "description": "路由表唯一ID。", "example": "rtb-qk8eyn9g" }, { "name": "RoutePolicyId", "type": "string", "required": false, "description": "路由接收策略唯一ID。", "example": "rrp-r70ctaia" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级。", "example": "100" } ] } ], "required": [ "RouteTableId", "RoutePolicyAssociationSet" ] }, { "name": "ResetRoutePolicyEntries", "description": "本接口（ResetRoutePolicyEntries）根据路由接收策略规则ID（RoutePolicyId）重置指定的路由接收策略条目（RoutePolicyEntry），支持批量修改。", "status": "online", "parameters": [ { "name": "RoutePolicyId", "type": "string", "required": true, "description": "路由接收策略实例ID，例如：rrp-azd4dt1c。", "example": "rrp-azd4dt1c" }, { "name": "RoutePolicyEntrySet", "type": "array", "required": false, "description": "路由接收策略条目列表。需要指定路由策略条目ID（RoutePolicyEntryId）。", "example": "无", "item_type": "object", "children": [ { "name": "RoutePolicyEntryId", "type": "string", "required": false, "description": "路由策略条目IPv4唯一ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "rrpi-hd7hsfhh" }, { "name": "CidrBlock", "type": "string", "required": false, "description": "目标网段。 注意：此字段可能返回 null，表示取不到有效值。", "example": "13.0.0.0/16" }, { "name": "Description", "type": "string", "required": false, "description": "路由策略规则描述。 注意：此字段可能返回 null，表示取不到有效值。", "example": "demo" }, { "name": "RouteType", "type": "string", "required": false, "description": "路由类型。 USER：用户自定义类型。 NETD：网络探测下发的路由。 CCN：云联网路由。 注意：此字段可能返回 null，表示取不到有效值。", "example": "CCN" }, { "name": "GatewayType", "type": "string", "required": false, "description": "下一跳类型。目前我们支持的类型有： CVM：公网网关类型的云服务器； VPN：VPN网关； DIRECTCONNECT：专线网关； PEERCONNECTION：对等连接； HAVIP：高可用虚拟IP； NAT：NAT网关; EIP：云服务器的公网IP； LOCAL_GATEWAY：本地网关; PVGW：PVGW网关。 注意：此字段可能返回 null，表示取不到有效值。", "example": "CVM" }, { "name": "GatewayId", "type": "string", "required": false, "description": "网关唯一ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "172.16.16.37" }, { "name": "Priority", "type": "integer", "required": false, "description": "优先级。数值越小，优先级越高。 注意：此字段可能返回 null，表示取不到有效值。", "example": "100" }, { "name": "Action", "type": "string", "required": false, "description": "动作。 DROP：丢弃。 DISABLE：接收且禁用。 ACCEPT：接收且启用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ACCEPT" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "创建时间。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2023-05-20 15:06:34" }, { "name": "Region", "type": "string", "required": false, "description": "地域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-guangzhou" } ] }, { "name": "RoutePolicyDescription", "type": "string", "required": false, "description": "路由接收策略描述。", "example": "TEST" }, { "name": "RoutePolicyName", "type": "string", "required": false, "description": "路由接收策略名字。", "example": "TEST" } ], "required": [ "RoutePolicyId" ] }, { "name": "ResetRoutes", "description": "本接口（ResetRoutes）用于对某个路由表名称和所有路由策略（Route）进行重新设置。 注意: 调用本接口时先删除当前路由表中所有路由策略, 再保存新提交的路由策略内容, 会引起网络中断。", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表实例ID，例如：rtb-azd4dt1c。", "example": "rtb-n0yejvje" }, { "name": "RouteTableName", "type": "string", "required": true, "description": "路由表名称，最大长度不能超过60个字节。", "example": "demo" }, { "name": "Routes", "type": "array", "required": true, "description": "路由策略。", "example": "[{\"DestinationCidrBlock\": \"10.0.0.10/32\", \"GatewayId\": \"10.0.0.17\", \"GatewayType\": \"NORMAL_CVM\", \"RouteDescription\": \"demo\"}]", "item_type": "object", "children": [ { "name": "DestinationCidrBlock", "type": "string", "required": true, "description": "创建IPv4目的网段，取值不能在私有网络网段内，例如：112.20.51.0/24。", "example": "10.0.0.0/24" }, { "name": "GatewayType", "type": "string", "required": true, "description": "下一跳类型，目前我们支持的类型有： CVM：公网网关类型的云服务器； VPN：VPN网关； DIRECTCONNECT：专线网关； PEERCONNECTION：对等连接； HAVIP：高可用虚拟IP； NAT：公网NAT网关; NORMAL_CVM：普通云服务器； EIP：云服务器的公网IP； LOCAL_GATEWAY：CDC本地网关； INTRANAT：私网NAT网关； USER_CCN：云联网（自定义路由）； GWLB_ENDPOINT：网关负载均衡终端节点。", "example": "CCN" }, { "name": "GatewayId", "type": "string", "required": true, "description": "下一跳地址，这里只需要指定不同下一跳类型的网关ID，系统会自动匹配到下一跳地址。 特殊说明： GatewayType为NORMAL_CVM时，GatewayId填写实例的内网IP。 GatewayType为EIP时，GatewayId填写0。", "example": "ccn-e187un9p" }, { "name": "RouteId", "type": "integer", "required": false, "description": "路由策略ID。IPv4路由策略ID是有意义的值，IPv6路由策略是无意义的值0。后续建议完全使用字符串唯一ID `RouteItemId`操作路由策略。 该字段在删除时必填，其他字段无需填写。", "example": "1289089" }, { "name": "RouteDescription", "type": "string", "required": false, "description": "路由策略描述。", "example": "demo" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否启用", "example": "true" }, { "name": "RouteType", "type": "string", "required": false, "description": "路由类型，目前我们支持的类型有： USER：用户路由； NETD：网络探测路由，创建网络探测实例时，系统默认下发，不可编辑与删除； CCN：云联网路由，系统默认下发，不可编辑与删除。 用户只能添加和操作 USER 类型的路由。", "example": "CCN" }, { "name": "RouteTableId", "type": "string", "required": false, "description": "路由表实例ID，例如：rtb-azd4dt1c。", "example": "rtb-azd4dt1c" }, { "name": "DestinationIpv6CidrBlock", "type": "string", "required": false, "description": "创建IPv6目的网段，取值不能在私有网络网段内，例如：2402:4e00:1000:810b::/64。", "example": "3402:4e00:20:1200::/56" }, { "name": "RouteItemId", "type": "string", "required": false, "description": "路由唯一策略ID。", "example": "rti-9bjer08h" }, { "name": "PublishedToVbc", "type": "boolean", "required": false, "description": "路由策略是否发布到云联网。该字段仅做出参使用，作为入参字段时此参数不生效。", "example": "true" }, { "name": "CreatedTime", "type": "string", "required": false, "description": "路由策略创建时间", "example": "2021-03-02 14:41:15" }, { "name": "CdcId", "type": "string", "required": false, "description": "CDC 集群唯一 ID。", "example": "cluster-d8htgb6k" } ] } ], "required": [ "RouteTableId", "RouteTableName", "Routes" ] }, { "name": "ResetTrafficMirrorFilter", "description": "本接口（ResetTrafficMirrorFilter）用于更新流量镜像实例过滤规则。 注意：每一个流量镜像实例，不能同时支持按nat网关和五元组两种规则过滤", "status": "online", "parameters": [ { "name": "TrafficMirrorId", "type": "string", "required": true, "description": "流量镜像实例ID", "example": "imgf-cvfp7xo8" }, { "name": "NatId", "type": "string", "required": false, "description": "流量镜像需要过滤的natgw实例ID", "example": "nat-qo7kugzg" }, { "name": "CollectorNormalFilters", "type": "array", "required": false, "description": "流量镜像需要过滤的五元组规则", "example": "无", "item_type": "object", "children": [ { "name": "SrcNet", "type": "string", "required": true, "description": "过滤规则的源网段", "example": "10.0.0.0/24" }, { "name": "DstNet", "type": "string", "required": true, "description": "过滤规则的目的网段", "example": "192.168.0.0/24" }, { "name": "Protocol", "type": "string", "required": true, "description": "过滤规则的协议", "example": "ALL" }, { "name": "SrcPort", "type": "string", "required": false, "description": "过滤规则的源端口，默认值1-65535", "example": "5000" }, { "name": "DstPort", "type": "string", "required": false, "description": "过滤规则的目的端口，默认值1-65535", "example": "3456" } ] } ], "required": [ "TrafficMirrorId" ] }, { "name": "ResetTrafficMirrorSrcs", "description": "本接口（ResetTrafficMirrorSrcs）用于重置流量镜像实例采集对象。", "status": "online", "parameters": [ { "name": "TrafficMirrorId", "type": "string", "required": true, "description": "流量镜像实例ID", "example": "imgf-cvfp7xo8" }, { "name": "CollectorSrcs", "type": "array", "required": true, "description": "流量镜像采集对象", "example": "[\"subnet-7v7ev09m\\r\\n\"]", "item_type": "string" } ], "required": [ "TrafficMirrorId", "CollectorSrcs" ] }, { "name": "ResetTrafficMirrorTarget", "description": "本接口（ResetTrafficMirrorTarget）用于更新流量镜像实例的接收目的信息。", "status": "online", "parameters": [ { "name": "TrafficMirrorId", "type": "string", "required": true, "description": "流量镜像实例ID", "example": "imgf-cvfp7xo8" }, { "name": "CollectorTarget", "type": "object", "required": true, "description": "流量镜像的接收目的信息", "example": "无", "children": [ { "name": "TargetIps", "type": "array", "required": false, "description": "流量镜像的接收IP", "example": "[\"10.0.0.0\"]", "item_type": "string" }, { "name": "AlgHash", "type": "string", "required": false, "description": "流量镜像接收IP组，均衡规则，支持ENI/FIVE_TUPLE_FLOW（vpc），FIVE_TUPLE_FLOW（公网IP）", "example": "FIVE_TUPLE_FLOW" }, { "name": "TargetEndPoints", "type": "array", "required": false, "description": "流量镜像的接收endpoint（公网IP）", "example": "10.0.0.0", "item_type": "string" }, { "name": "TargetType", "type": "string", "required": false, "description": "流量镜像的接收类型，分别为：IP/ENI/CLB", "example": "IP" } ] }, { "name": "SubnetId", "type": "string", "required": false, "description": "公网IP类型的流量镜像采集流量的发送端所属子网", "example": "subnet-as2osi38" } ], "required": [ "TrafficMirrorId", "CollectorTarget" ] }, { "name": "ResetVpnConnection", "description": "本接口（ResetVpnConnection）用于重置VPN通道。", "status": "online", "parameters": [ { "name": "VpnGatewayId", "type": "string", "required": true, "description": "VPN网关实例ID。", "example": "vpngw-kjllnkew" }, { "name": "VpnConnectionId", "type": "string", "required": true, "description": "VPN通道实例ID。形如：vpnx-f49l6u0z。", "example": "vpnx-f29e6u0z" } ], "required": [ "VpnGatewayId", "VpnConnectionId" ] }, { "name": "ResetVpnGatewayInternetMaxBandwidth", "description": "本接口（ResetVpnGatewayInternetMaxBandwidth）用于调整VPN网关带宽上限。VPN网关带宽目前仅支持部分带宽范围内升降配，如【5,100】Mbps和【200,1000】Mbps，在各自带宽范围内可提升配额，跨范围提升配额和降配暂不支持，如果是包年包月VPN网关需要在有效期内。", "status": "online", "parameters": [ { "name": "VpnGatewayId", "type": "string", "required": true, "description": "VPN网关实例ID。", "example": "vpngw-ajclakqw" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": true, "description": "新规格公网带宽设置。可选带宽规格：5, 10, 20, 50, 100, 200, 500, 1000；单位：Mbps。VPN网关带宽目前仅支持部分带宽范围内升降配，如【5,100】Mbps和【200,1000】Mbps，在各自带宽范围内可提升配额，跨范围提升配额和降配暂不支持。", "example": "5" } ], "required": [ "VpnGatewayId", "InternetMaxBandwidthOut" ] }, { "name": "ResumeSnapshotInstance", "description": "本接口（ResumeSnapshotInstance）用于根据备份内容恢复安全组策略。", "status": "online", "parameters": [ { "name": "SnapshotPolicyId", "type": "string", "required": true, "description": "快照策略Id。", "example": "sspolicy-hx8an9sr" }, { "name": "SnapshotFileId", "type": "string", "required": true, "description": "快照文件Id。", "example": "ssfile-emtabuwu2z" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id。", "example": "sg-ntrgm89v" } ], "required": [ "SnapshotPolicyId", "SnapshotFileId", "InstanceId" ] }, { "name": "ReturnNormalAddresses", "description": "本接口（ReturnNormalAddresses）用于解绑并释放普通公网IP。 为完善公网IP的访问管理功能，此接口于2022年12月15日升级优化鉴权功能，升级后子用户调用此接口需向主账号申请CAM策略授权，否则可能调用失败。您可以提前为子账号配置操作授权，详情见[授权指南](https://cloud.tencent.com/document/product/598/34545)。", "status": "online", "parameters": [ { "name": "AddressIps", "type": "array", "required": true, "description": "普通公网IP 的 IP 地址，可以使用[DescribeAddresses](https://cloud.tencent.com/document/product/215/16702)接口获取AddressIps。", "example": "[\"101.35.139.183\"]", "item_type": "string" } ], "required": [ "AddressIps" ] }, { "name": "SetCcnRegionBandwidthLimits", "description": "本接口（SetCcnRegionBandwidthLimits）用于设置云联网（CCN）各地域出带宽上限，或者地域间带宽上限。", "status": "online", "parameters": [ { "name": "CcnId", "type": "string", "required": true, "description": "CCN实例ID，形如：ccn-f49l6u0z。", "example": "ccn-f49l6u0z" }, { "name": "CcnRegionBandwidthLimits", "type": "array", "required": true, "description": "云联网（CCN）各地域出带宽上限。", "example": "无", "item_type": "object", "children": [ { "name": "Region", "type": "string", "required": true, "description": "地域，例如：ap-guangzhou", "example": "ap-shanghai" }, { "name": "BandwidthLimit", "type": "integer", "required": true, "description": "出带宽上限，单位：Mbps", "example": "1000" }, { "name": "IsBm", "type": "boolean", "required": false, "description": "是否黑石地域，默认`false`。", "example": "False" }, { "name": "DstRegion", "type": "string", "required": false, "description": "目的地域，例如：ap-shanghai", "example": "ap-beijing" }, { "name": "DstIsBm", "type": "boolean", "required": false, "description": "目的地域是否为黑石地域，默认`false`。", "example": "False" } ] }, { "name": "SetDefaultLimitFlag", "type": "boolean", "required": false, "description": "是否恢复云联网地域出口/地域间带宽限速为默认值（1Gbps）。false表示不恢复；true表示恢复。恢复默认值后，限速实例将不在控制台展示。该参数默认为 false，不恢复。", "example": "true" } ], "required": [ "CcnId", "CcnRegionBandwidthLimits" ] }, { "name": "SetVpnGatewaysRenewFlag", "description": "本接口（SetVpnGatewaysRenewFlag）用于设置VPNGW续费标记。", "status": "online", "parameters": [ { "name": "VpnGatewayIds", "type": "array", "required": true, "description": "VPNGW字符型ID列表。可通过[DescribeVpnGateways](https://cloud.tencent.com/document/api/215/17514)接口返回值VpnGatewaySet中的VpnGatewayId获取，只能选择包年包月的VPN实例。", "example": "['vpngw-m6hhy6or']", "item_type": "string" }, { "name": "AutoRenewFlag", "type": "integer", "required": true, "description": "自动续费标记 [0, 1, 2] 0表示默认状态(初始状态)， 1表示自动续费，2表示明确不自动续费。", "example": "2" }, { "name": "Type", "type": "string", "required": false, "description": "VPNGW类型['IPSEC', 'SSL']， 默认为IPSEC。", "example": "IPSEC" } ], "required": [ "VpnGatewayIds", "AutoRenewFlag" ] }, { "name": "StartTrafficMirror", "description": "本接口（StartTrafficMirror）用于开启流量镜像实例。", "status": "online", "parameters": [ { "name": "TrafficMirrorId", "type": "string", "required": true, "description": "流量镜像实例ID", "example": "imgf-cvfp7xo8" } ], "required": [ "TrafficMirrorId" ] }, { "name": "StopTrafficMirror", "description": "本接口（StopTrafficMirror）用于关闭流量镜像实例。", "status": "online", "parameters": [ { "name": "TrafficMirrorId", "type": "string", "required": true, "description": "流量镜像实例ID", "example": "imgf-cvfp7xo8" } ], "required": [ "TrafficMirrorId" ] }, { "name": "TransformAddress", "description": "本接口 (TransformAddress) 用于将实例的普通公网 IP 转换为[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)（简称 EIP）。 * 平台对用户单地域每日解绑 EIP 重新分配普通公网 IP 次数有所限制（可参见 [EIP 产品简介](/document/product/213/1941)）。上述配额可通过 [DescribeAddressQuota](https://cloud.tencent.com/document/product/215/16701) 接口获取。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待操作有普通公网 IP 的实例 ID。实例 ID 形如：`ins-11112222`。可通过登录[控制台](https://console.cloud.tencent.com/cvm)查询，也可通过 [DescribeInstances](https://cloud.tencent.com/document/api/213/9389) 接口返回值中的`InstanceId`获取。", "example": "ins-3ea0qeu6" } ], "required": [ "InstanceId" ] }, { "name": "UnassignIpv6Addresses", "description": "本接口（UnassignIpv6Addresses）用于释放弹性网卡`IPv6`地址。 本接口是异步完成，如需查询异步任务执行结果，请使用本接口返回的`RequestId`轮询[DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037)接口。", "status": "online", "parameters": [ { "name": "NetworkInterfaceId", "type": "string", "required": true, "description": "弹性网卡实例`ID`，形如：`eni-m6dyj72l`。可通过[DescribeNetworkInterfaces](https://cloud.tencent.com/document/product/215/15817)接口获取。", "example": "eni-9c8zkfev" }, { "name": "Ipv6Addresses", "type": "array", "required": true, "description": "指定的`IPv6`地址列表，单次最多指定10个。", "example": "无", "item_type": "object", "children": [ { "name": "Address", "type": "string", "required": true, "description": "`IPv6`地址，形如：`3402:4e00:20:100:0:8cd9:2a67:71f3`", "example": "3402:4e00:20:1202::1" }, { "name": "Primary", "type": "boolean", "required": false, "description": "是否是主`IP`。", "example": "false" }, { "name": "AddressId", "type": "string", "required": false, "description": "`EIP`实例`ID`，形如：`eip-hxlqja90`。作为入参数时，可通过[DescribeAddresses](https://cloud.tencent.com/document/product/215/16702)接口获取。", "example": "eip-5k6fot41" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息。", "example": "demo" }, { "name": "IsWanIpBlocked", "type": "boolean", "required": false, "description": "公网IP是否被封堵。", "example": "false" }, { "name": "State", "type": "string", "required": false, "description": "`IPv6`地址状态： `PENDING`：生产中 `MIGRATING`：迁移中 `DELETING`：删除中 `AVAILABLE`：可用的", "example": "AVAILABLE" }, { "name": "PublicIpAddress", "type": "string", "required": false, "description": "如果 IPv6地址是 ULA 类型，绑定的公网IP地址。", "example": "3402:4e00:20:1202::2" }, { "name": "AddressType", "type": "string", "required": false, "description": "`IPv6`地址的类型: `GUA`(全球单播地址), `ULA`(唯一本地地址)", "example": "ULA" } ] } ], "required": [ "NetworkInterfaceId", "Ipv6Addresses" ] }, { "name": "UnassignIpv6CidrBlock", "description": "本接口（UnassignIpv6CidrBlock）用于释放IPv6网段。 网段如果还有IP占用且未回收，则网段无法释放。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "`VPC`实例`ID`，形如：`vpc-f49l6u0z`。", "example": "vpc-f49l6u0z" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "`IPv6`网段。形如：`3402:4e00:20:1000::/56`。", "example": "3402:4e00:20:1000::/56" } ], "required": [ "VpcId" ] }, { "name": "UnassignIpv6SubnetCidrBlock", "description": "本接口（UnassignIpv6SubnetCidrBlock）用于释放IPv6子网段。 子网段如果还有IP占用且未回收，则子网段无法释放。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "子网所在私有网络`ID`。形如：`vpc-f49l6u0z`。", "example": "vpc-q26u781x" }, { "name": "Ipv6SubnetCidrBlocks", "type": "array", "required": true, "description": "`IPv6` 子网段列表。", "example": "[{'SubnetId': 'subnet-8uwg949c'}]", "item_type": "object", "children": [ { "name": "SubnetId", "type": "string", "required": true, "description": "子网实例`ID`。形如：`subnet-pxir56ns`。", "example": "subnet-kgpu7qt2" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "`IPv6`子网段。形如：`3402:4e00:20:1001::/64`。作为AssignIpv6SubnetCidrBlock接口入参时，该参数必填。", "example": "3402:4e00:20:1202::/64" } ] } ], "required": [ "VpcId", "Ipv6SubnetCidrBlocks" ] }, { "name": "UnassignPrivateIpAddresses", "description": "本接口（UnassignPrivateIpAddresses）用于弹性网卡退还内网 IP。 * 退还弹性网卡上的辅助内网IP，接口自动解除关联弹性公网 IP。不能退还弹性网卡的主内网IP。 本接口是异步完成，如需查询异步任务执行结果，请使用本接口返回的`RequestId`轮询[DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口。", "status": "online", "parameters": [ { "name": "NetworkInterfaceId", "type": "string", "required": true, "description": "弹性网卡实例ID，例如：eni-m6dyj72l。可通过[DescribeNetworkInterfaces](https://cloud.tencent.com/document/product/215/15817)接口获取。", "example": "eni-afo43z61" }, { "name": "PrivateIpAddresses", "type": "array", "required": true, "description": "指定的内网IP信息，单次最多指定10个。", "example": "无", "item_type": "object", "children": [ { "name": "PrivateIpAddress", "type": "string", "required": false, "description": "内网IP地址。", "example": "192.168.0.10" }, { "name": "Primary", "type": "boolean", "required": false, "description": "是否是主IP。", "example": "false" }, { "name": "PublicIpAddress", "type": "string", "required": false, "description": "公网IP地址。", "example": "123.10.100.171" }, { "name": "AddressId", "type": "string", "required": false, "description": "EIP实例ID，例如：eip-11112222。", "example": "eip-29mdigub" }, { "name": "Description", "type": "string", "required": false, "description": "内网IP描述信息。", "example": "demo" }, { "name": "IsWanIpBlocked", "type": "boolean", "required": false, "description": "公网IP是否被封堵。", "example": "false" }, { "name": "State", "type": "string", "required": false, "description": "IP状态： PENDING：生产中 MIGRATING：迁移中 DELETING：删除中 AVAILABLE：可用的", "example": "AVAILABLE" }, { "name": "QosLevel", "type": "string", "required": false, "description": "IP服务质量等级，可选值：PT（云金）、AU（云银）、AG(云铜）、DEFAULT（默认）。", "example": "PT" } ] }, { "name": "InstanceId", "type": "string", "required": false, "description": "网卡绑定的子机实例ID，该参数仅用于指定网卡退还IP并解绑子机的场景，如果不涉及解绑子机，请勿填写。可通过[DescribeInstances](https://cloud.tencent.com/document/product/213/15728)接口获取。", "example": "ins-3456tghy" } ], "required": [ "NetworkInterfaceId", "PrivateIpAddresses" ] }, { "name": "UnlockCcnBandwidths", "description": "本接口（UnlockCcnBandwidths）用户解锁云联网限速实例。 该接口一般用来封禁地域间限速的云联网实例下的限速实例, 目前联通内部运营系统通过云API调用, 如果是出口限速, 一般使用更粗的云联网实例粒度封禁（SecurityUnlockCcns）。 如有需要, 可以封禁任意限速实例, 可接入到内部运营系统。", "status": "online", "parameters": [ { "name": "Instances", "type": "array", "required": true, "description": "带宽实例对象数组。", "example": "{ 'CcnId': 'ccn-xxxxxxxx', 'RegionFlowControlId': 'fcr-xxxxxxxx', 'UserAccountID': 'xxxxxxxxxx' }", "item_type": "object", "children": [ { "name": "CcnId", "type": "string", "required": true, "description": "带宽所属的云联网ID。", "example": "ccn-2caehl6h" }, { "name": "UserAccountID", "type": "string", "required": true, "description": "实例所属用户主账号ID。", "example": "201111300001" }, { "name": "RegionFlowControlId", "type": "string", "required": false, "description": "带宽实例的唯一ID。作为`UnlockCcnBandwidths`接口和`LockCcnBandwidths`接口的入参时，该字段必传。", "example": "fcr-ceah9fdm" } ] } ], "required": [ "Instances" ] }, { "name": "UnlockCcns", "description": "本接口（UnlockCcns）用于解锁云联网实例 该接口一般用来解封禁出口限速的云联网实例, 目前联通内部运营系统通过云API调用, 因为出口限速无法按地域间解封禁, 只能按更粗的云联网实例粒度解封禁, 如果是地域间限速, 一般可以通过更细的限速实例粒度解封禁（UnlockCcnBandwidths） 如有需要, 可以封禁任意限速实例, 可接入到内部运营系统", "status": "online", "parameters": [], "required": [] }, { "name": "UpdateTrafficMirrorAllFilter", "description": "本接口（UpdateTrafficMirrorAllFilter）用于更新流量镜像实例的过滤规则或者采集对象。", "status": "online", "parameters": [ { "name": "TrafficMirrorId", "type": "string", "required": true, "description": "流量镜像实例ID", "example": "imgf-cvfp7xo8" }, { "name": "Direction", "type": "string", "required": true, "description": "流量镜像采集方向", "example": "ALL" }, { "name": "CollectorSrcs", "type": "array", "required": false, "description": "流量镜像采集对象", "example": "[\"eni-1iso930s\"]", "item_type": "string" }, { "name": "NatId", "type": "string", "required": false, "description": "流量镜像需要过滤的natgw实例", "example": "nat-sow01oa8" }, { "name": "CollectorNormalFilters", "type": "array", "required": false, "description": "流量镜像需要过滤的五元组规则", "example": "无", "item_type": "object", "children": [ { "name": "SrcNet", "type": "string", "required": true, "description": "过滤规则的源网段", "example": "10.0.0.0/24" }, { "name": "DstNet", "type": "string", "required": true, "description": "过滤规则的目的网段", "example": "192.168.0.0/24" }, { "name": "Protocol", "type": "string", "required": true, "description": "过滤规则的协议", "example": "ALL" }, { "name": "SrcPort", "type": "string", "required": false, "description": "过滤规则的源端口，默认值1-65535", "example": "5000" }, { "name": "DstPort", "type": "string", "required": false, "description": "过滤规则的目的端口，默认值1-65535", "example": "3456" } ] } ], "required": [ "TrafficMirrorId", "Direction" ] }, { "name": "UpdateTrafficMirrorDirection", "description": "本接口（UpdateTrafficMirrorDirection）用于更新流量镜像实例的采集方向。", "status": "online", "parameters": [ { "name": "TrafficMirrorId", "type": "string", "required": true, "description": "流量镜像实例ID", "example": "imgf-cvfp7xo8" }, { "name": "Direction", "type": "string", "required": true, "description": "流量镜像采集方向", "example": "INGRESS" } ], "required": [ "TrafficMirrorId", "Direction" ] }, { "name": "UpgradeNatGatewayProductVersion", "description": "本接口（UpgradeNatGatewayProductVersion）用于升级NAT实例产品版本，将传统型NAT实例升级到标准型NAT。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。", "example": "vpc-oty76xyl" }, { "name": "NatGatewayId", "type": "string", "required": true, "description": "NAT网关的ID，形如：`nat-ig8xpno8`。", "example": "nat-ig8xpno8" }, { "name": "Force", "type": "integer", "required": true, "description": "是否热迁移。1表示冷迁移，0表示热迁移，默认值是0。", "example": "1" }, { "name": "CheckOnlyMode", "type": "boolean", "required": false, "description": "是否仅校验迁移可能性。true表示仅校验能否迁移，不做实际迁移。false表示正常迁移。默认值为false。 仅校验模式，不报错表示校验迁移成功。", "example": "true" } ], "required": [ "VpcId", "NatGatewayId", "Force" ] }, { "name": "WithdrawNotifyRoutes", "description": "本接口（WithdrawNotifyRoutes）用于撤销已发布到云联网的路由。路由表列表页操作增加“从云联网撤销”。", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表唯一ID。", "example": "rtb-9wzwlnhc" }, { "name": "RouteItemIds", "type": "array", "required": true, "description": "路由策略唯一ID。", "example": "[\"rti-i8bap903\\n\"]", "item_type": "string" } ], "required": [ "RouteTableId", "RouteItemIds" ] } ] }