{ "name": "ecm", "display_name": "边缘计算机器", "description": "介绍如何使用API对边缘计算机器进行操作，包括管理弹性网卡、管理实例等。", "domain": "other", "api_version": "2019-07-19", "endpoint": "ecm.tencentcloudapi.com", "actions": [ { "name": "AllocateAddresses", "description": "申请一个或多个弹性公网IP（简称 EIP）", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域", "example": "ap-xian-ecm" }, { "name": "AddressCount", "type": "integer", "required": false, "description": "EIP数量。默认值：1。", "example": "1" }, { "name": "InternetServiceProvider", "type": "string", "required": false, "description": "CMCC：中国移动 CTCC：中国电信 CUCC：中国联通", "example": "CTCC" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "1 Mbps 至 5000 Mbps，默认值：1 Mbps。", "example": "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": true, "description": "标签值。", "example": "tag-val" } ] }, { "name": "InstanceId", "type": "string", "required": false, "description": "要绑定的实例 ID。", "example": "ins-11112222" }, { "name": "NetworkInterfaceId", "type": "string", "required": false, "description": "要绑定的弹性网卡 ID。 弹性网卡 ID 形如：eni-11112222。NetworkInterfaceId 与 InstanceId 不可同时指定。弹性网卡 ID 可通过DescribeNetworkInterfaces接口返回值中的networkInterfaceId获取。", "example": "eni-11112222" }, { "name": "PrivateIpAddress", "type": "string", "required": false, "description": "要绑定的内网 IP。如果指定了 NetworkInterfaceId 则也必须指定 PrivateIpAddress ，表示将 EIP 绑定到指定弹性网卡的指定内网 IP 上。同时要确保指定的 PrivateIpAddress 是指定的 NetworkInterfaceId 上的一个内网 IP。指定弹性网卡的内网 IP 可通过DescribeNetworkInterfaces接口返回值中的privateIpAddress获取。", "example": "10.0.0.13" } ], "required": [ "EcmRegion" ] }, { "name": "AllocateIpv6AddressesBandwidth", "description": "本接口用于给IPv6地址分配公网带宽", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域。", "example": "ap-xian-ecm" }, { "name": "Ipv6Addresses", "type": "array", "required": true, "description": "需要开通公网访问能力的IPV6地址。", "example": "[\"2402:4e00:1200:1809:0:8ef6:b82b:513b\"]", "item_type": "string" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "带宽，单位Mbps，默认是1Mbps。", "example": "1" }, { "name": "InternetChargeType", "type": "string", "required": false, "description": "网络计费模式，当前支持 BANDWIDTH_PACKAGE。", "example": "BANDWIDTH_PACKAGE" } ], "required": [ "EcmRegion", "Ipv6Addresses" ] }, { "name": "AssignIpv6Addresses", "description": "本接口（AssignIpv6Addresses）用于弹性网卡申请IPv6地址。", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域", "example": "ap-xian-ecm" }, { "name": "NetworkInterfaceId", "type": "string", "required": true, "description": "弹性网卡实例ID，形如：eni-1snva0vd。目前只支持主网卡上分配。", "example": "eni-1snva0vd" }, { "name": "Ipv6Addresses", "type": "array", "required": false, "description": "指定的IPv6地址列表，单次最多指定10个。与入参Ipv6AddressCount合并计算配额。与Ipv6AddressCount必填一个。", "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:100:0:8cd9:2a67:71f3" }, { "name": "Primary", "type": "boolean", "required": false, "description": "是否是主IP。", "example": "true" }, { "name": "AddressId", "type": "string", "required": false, "description": "EIP实例ID，形如：eip-hxlqja90。", "example": "eip-hxlqja90" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息。", "example": "demo" }, { "name": "IsWanIpBlocked", "type": "boolean", "required": false, "description": "公网IP是否被封堵。", "example": "true" }, { "name": "State", "type": "string", "required": false, "description": "IPv6地址状态： PENDING：生产中 MIGRATING：迁移中 DELETING：删除中 AVAILABLE：可用的", "example": "AVAILABLE" } ] }, { "name": "Ipv6AddressCount", "type": "integer", "required": false, "description": "自动分配IPv6地址个数，内网IP地址个数总和不能超过配数。与入参Ipv6Addresses合并计算配额。与Ipv6Addresses必填一个。", "example": "1" }, { "name": "ISPType", "type": "string", "required": false, "description": "ipv6运营商如下： CTCC：中国电信 CUCC：中国联通 CMCC：中国移动", "example": "CTCC" }, { "name": "SkipCheckIPv6Address", "type": "boolean", "required": false, "description": "是否跳过校验一个网卡只能分配一个IPv6 CIDR。该字段通常为true（用于兼容存量子机只有一个地址的情形）。", "example": "true" }, { "name": "SkipAllocateBandwidth", "type": "boolean", "required": false, "description": "是否跳过自动开通公网带宽。通常为true(根据运营系统的用户配置来决定是否自动开通，以支持当前子机购买时的行为）。", "example": "true" } ], "required": [ "EcmRegion", "NetworkInterfaceId" ] }, { "name": "AssignIpv6CidrBlock", "description": "本接口（AssignIpv6CidrBlock）用于分配IPv6网段。 使用本接口前，您需要已有VPC实例，如果没有可通过接口CreateVpc创建。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "`VPC`实例`ID`，形如：`vpc-f49l6u0z`。", "example": "vpc-f49l6u0z`" }, { "name": "ISPType", "type": "string", "required": true, "description": "网络运营商类型 'CMCC'-中国移动, 'CTCC'-中国电信, 'CUCC'-中国联调", "example": "CMCC" }, { "name": "EcmRegion", "type": "string", "required": false, "description": "ECM地域。", "example": "ap-hefei-ecm" } ], "required": [ "VpcId", "ISPType" ] }, { "name": "AssignIpv6CidrBlocks", "description": "本接口（AssignIpv6CidrBlocks）用于分配IPv6网段。 使用本接口前，您需要已有VPC实例，如果没有可通过接口CreateVpc创建。 每个VPC 可以同时支持运营商网络('CMCC'-中国移动, 'CTCC'-中国电信, 'CUCC'-中国联调)。本接口可以同时申请不同类型的IPv6网段", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "`VPC`实例`ID`，形如：`vpc-f49l6u0z`。", "example": "vpc-rkxd3pgh\t" }, { "name": "ISPTypes", "type": "array", "required": true, "description": "网络运营商类型 取值范围:'CMCC'-中国移动, 'CTCC'-中国电信, 'CUCC'-中国联调", "example": "[{\"ISPType\":\"BGP\", \"Count\":1}]\t", "item_type": "object", "children": [ { "name": "ISPType", "type": "string", "required": false, "description": "IPv6 Cidr所属运营商类型，支持的类型有 'CMCC'-中国移动, 'CTCC'-中国电信, 'CUCC'-中国联调。作为入参数时为必选。", "example": "CMCC" }, { "name": "Count", "type": "integer", "required": false, "description": "申请IPv6 Cidr Block的个数。作为入参数时为必选。", "example": "1" } ] }, { "name": "EcmRegion", "type": "string", "required": false, "description": "ECM地域。", "example": "ap-hefei-ecm" } ], "required": [ "VpcId", "ISPTypes" ] }, { "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-f49l6u0z" }, { "name": "Ipv6SubnetCidrBlocks", "type": "array", "required": true, "description": "分配 `IPv6` 子网段列表。", "example": "无", "item_type": "object", "children": [ { "name": "SubnetId", "type": "string", "required": false, "description": "子网实例`ID`。形如：`subnet-pxir56ns`。 注意：此字段可能返回 null，表示取不到有效值。", "example": "subnet-pxir56ns" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "`IPv6`子网段。形如：`3402:4e00:20:1001::/64` 注意：此字段可能返回 null，表示取不到有效值。", "example": "3402:4e00:20:1001::/64" } ] }, { "name": "EcmRegion", "type": "string", "required": false, "description": "ECM地域。", "example": "ap-hefei-ecm" } ], "required": [ "VpcId", "Ipv6SubnetCidrBlocks" ] }, { "name": "AssignPrivateIpAddresses", "description": "弹性网卡申请内网 IP", "status": "online", "parameters": [ { "name": "NetworkInterfaceId", "type": "string", "required": true, "description": "弹性网卡实例ID，例如：eni-m6dyj72l。", "example": "eni-ms7c7gcr" }, { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域，形如ap-xian-ecm。", "example": "ap-hangzhou-ecm" }, { "name": "PrivateIpAddresses", "type": "array", "required": false, "description": "指定的内网IP信息，单次最多指定10个。与SecondaryPrivateIpAddressCount至少提供一个。", "example": "[{\"PrivateIpAddress\": \"10.0.0.11\"}]", "item_type": "object", "children": [ { "name": "PrivateIpAddress", "type": "string", "required": true, "description": "内网IP地址。", "example": "10.0.0.11" }, { "name": "Primary", "type": "boolean", "required": false, "description": "是否是主IP。", "example": "false" }, { "name": "PublicIpAddress", "type": "string", "required": false, "description": "公网IP地址。", "example": "123.11.100.87" }, { "name": "AddressId", "type": "string", "required": false, "description": "EIP实例ID，例如：eip-11112222。", "example": "eip-ms7c7gcr" }, { "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": "SecondaryPrivateIpAddressCount", "type": "integer", "required": false, "description": "新申请的内网IP地址个数，与PrivateIpAddresses至少提供一个。内网IP地址个数总和不能超过配额数", "example": "1" } ], "required": [ "NetworkInterfaceId", "EcmRegion" ] }, { "name": "AssociateAddress", "description": "将弹性公网IP（简称 EIP）绑定到实例或弹性网卡的指定内网 IP 上。 将 EIP 绑定到实例（ECM）上，其本质是将 EIP 绑定到实例上主网卡的主内网 IP 上。 将 EIP 绑定到指定网卡的内网 IP上，内网IP已经绑定了EIP或普通公网IP，则反馈失败。必须先解绑该 EIP，才能再绑定新的。 只有状态为 UNBIND 的 EIP 才能够绑定内网IP。", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域", "example": "ap-chongqing-ecm2" }, { "name": "AddressId", "type": "string", "required": true, "description": "标识 EIP 的唯一 ID。EIP 唯一 ID 形如：eip-11112222。", "example": "eip-aihfuscm" }, { "name": "InstanceId", "type": "string", "required": false, "description": "要绑定的实例 ID。", "example": "ins-jfaukmsn" }, { "name": "NetworkInterfaceId", "type": "string", "required": false, "description": "要绑定的弹性网卡 ID。 弹性网卡 ID 形如：eni-11112222。NetworkInterfaceId 与 InstanceId 不可同时指定。弹性网卡 ID 可通过DescribeNetworkInterfaces接口返回值中的networkInterfaceId获取。", "example": "eni-ea173k1x" }, { "name": "PrivateIpAddress", "type": "string", "required": false, "description": "要绑定的内网 IP。如果指定了 NetworkInterfaceId 则也必须指定 PrivateIpAddress ，表示将 EIP 绑定到指定弹性网卡的指定内网 IP 上。同时要确保指定的 PrivateIpAddress 是指定的 NetworkInterfaceId 上的一个内网 IP。指定弹性网卡的内网 IP 可通过DescribeNetworkInterfaces接口返回值中的privateIpAddress获取。", "example": "10.0.2.27" } ], "required": [ "EcmRegion", "AddressId" ] }, { "name": "AssociateSecurityGroups", "description": "绑定安全组", "status": "online", "parameters": [ { "name": "SecurityGroupIds", "type": "array", "required": true, "description": "要绑定的安全组ID，类似esg-efil73jd，只支持绑定单个安全组。", "item_type": "string" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "被绑定的实例ID，类似ein-lesecurk，支持指定多个实例，每次请求批量实例的上限为100。", "item_type": "string" } ], "required": [ "SecurityGroupIds", "InstanceIds" ] }, { "name": "AttachDisks", "description": "CBS在ECM早已下线 本接口（AttachDisks）用于挂载云硬盘。 * 支持批量操作，将多块云盘挂载到同一云主机。如果多个云盘中存在不允许挂载的云盘，则操作不执行，返回特定的错误码。 * 本接口为异步接口，当挂载云盘的请求成功返回时，表示后台已发起挂载云盘的操作，可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态，如果云盘的状态由“ATTACHING”变为“ATT...", "status": "deprecated", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "云服务器实例ID。云盘将被挂载到此云服务器上，通过[DescribeInstances](/document/product/213/15728)接口查询。", "example": "ins-9oxguxa" }, { "name": "DiskIds", "type": "array", "required": true, "description": "将要被挂载的弹性云盘ID。通过[DescribeDisks](/document/product/362/16315)接口查询。单次最多可挂载10块弹性云盘。", "example": "[\"disk-l7mxexxc\"]", "item_type": "string" }, { "name": "DeleteWithInstance", "type": "boolean", "required": false, "description": "可选参数，不传该参数则仅执行挂载操作。传入`True`时，会在挂载成功后将云硬盘设置为随云主机销毁模式，仅对按量计费云硬盘有效。", "example": "TRUE" }, { "name": "AttachMode", "type": "string", "required": false, "description": "可选参数，用于控制云盘挂载时使用的挂载模式，目前仅对黑石裸金属机型有效。取值范围：PFVF", "example": "PF" } ], "required": [ "InstanceId", "DiskIds" ] }, { "name": "AttachNetworkInterface", "description": "弹性网卡绑定云主机", "status": "online", "parameters": [ { "name": "NetworkInterfaceId", "type": "string", "required": true, "description": "弹性网卡实例ID，例如：eni-m6dyj72l。", "example": "eni-m6dyj72l" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。形如：ein-r8hr2upy。", "example": "ein-r8hr2upy" }, { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域，形如ap-xian-ecm。", "example": "ap-hangzhou-ecm" } ], "required": [ "NetworkInterfaceId", "InstanceId", "EcmRegion" ] }, { "name": "BatchDeregisterTargets", "description": "批量解绑后端服务。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡ID" }, { "name": "Targets", "type": "array", "required": true, "description": "解绑目标", "item_type": "object", "children": [ { "name": "ListenerId", "type": "string", "required": false, "description": "监听器ID" }, { "name": "Port", "type": "integer", "required": false, "description": "绑定端口" }, { "name": "InstanceId", "type": "string", "required": false, "description": "子机ID" }, { "name": "EniIp", "type": "string", "required": false, "description": "弹性网卡ip" }, { "name": "Weight", "type": "integer", "required": false, "description": "子机权重，范围[0, 100]。绑定时如果不存在，则默认为10。" } ] } ], "required": [ "LoadBalancerId", "Targets" ] }, { "name": "BatchModifyTargetWeight", "description": "批量修改监听器绑定的后端机器的转发权重。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID" }, { "name": "ModifyList", "type": "array", "required": true, "description": "要批量修改权重的列表", "item_type": "object", "children": [ { "name": "ListenerId", "type": "string", "required": false, "description": "负载均衡监听器 ID" }, { "name": "Targets", "type": "array", "required": false, "description": "要修改权重的后端机器列表", "item_type": "object", "children": [ { "name": "Port", "type": "integer", "required": false, "description": "后端服务的监听端口" }, { "name": "InstanceId", "type": "string", "required": false, "description": "子机ID" }, { "name": "Weight", "type": "integer", "required": false, "description": "后端服务的转发权重，取值范围：[0, 100]，默认为 10。" }, { "name": "EniIp", "type": "string", "required": false, "description": "绑定弹性网卡时需要传入此参数，代表弹性网卡的IP，弹性网卡必须先绑定至子机，然后才能绑定到负载均衡实例。注意：参数 InstanceId 和 EniIp 只能传入一个且必须传入一个。" } ] }, { "name": "Weight", "type": "integer", "required": false, "description": "后端服务新的转发权重，取值范围：0~100。" } ] } ], "required": [ "LoadBalancerId", "ModifyList" ] }, { "name": "BatchRegisterTargets", "description": "批量绑定后端目标。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡ID" }, { "name": "Targets", "type": "array", "required": true, "description": "绑定目标", "item_type": "object", "children": [ { "name": "ListenerId", "type": "string", "required": false, "description": "监听器ID" }, { "name": "Port", "type": "integer", "required": false, "description": "绑定端口" }, { "name": "InstanceId", "type": "string", "required": false, "description": "子机ID" }, { "name": "EniIp", "type": "string", "required": false, "description": "弹性网卡ip" }, { "name": "Weight", "type": "integer", "required": false, "description": "子机权重，范围[0, 100]。绑定时如果不存在，则默认为10。" } ] } ], "required": [ "LoadBalancerId", "Targets" ] }, { "name": "CreateDisks", "description": "CBS在ECM早已下线 本接口（CreateDisks）用于创建云硬盘。 * 预付费云盘的购买会预先扣除本次云盘购买所需金额，在调用本接口前请确保账户余额充足。 * 本接口支持传入数据盘快照来创建云盘，实现将快照数据复制到新购云盘上。 * 本接口为异步接口，当创建请求下发成功后会返回一个新建的云盘ID列表，此时云盘的创建并未立即完成。可以通过调用[DescribeDisks](/document/product/36...", "status": "deprecated", "parameters": [ { "name": "Placement", "type": "object", "required": true, "description": "实例所在的位置。通过该参数可以指定实例所属可用区，所属项目。若不指定项目，将在默认项目下进行创建。", "example": "无", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "云硬盘所属的[可用区](/document/product/213/15753#ZoneInfo)。该参数也可以通过调用 [DescribeZones](/document/product/213/15707) 的返回值中的Zone字段来获取。", "example": "无" }, { "name": "CageId", "type": "string", "required": false, "description": "围笼Id。作为入参时，表示对指定的CageId的资源进行操作，可为空。 作为出参时，表示资源所属围笼ID，可为空。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "实例所属项目ID。该参数可以通过调用 [DescribeProject](/document/api/378/4400) 的返回值中的 projectId 字段来获取。不填为默认项目。", "example": "无" }, { "name": "CdcName", "type": "string", "required": false, "description": "独享集群名字。作为入参时，忽略。作为出参时，表示云硬盘所属的独享集群名，可为空。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "CdcId", "type": "string", "required": false, "description": "实例所属的独享集群ID。作为入参时，表示对指定的CdcId独享集群的资源进行操作，可为空。 作为出参时，表示资源所属的独享集群的ID，可为空。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "DiskChargeType", "type": "string", "required": true, "description": "云硬盘计费类型。PREPAID：预付费，即包年包月POSTPAID_BY_HOUR：按小时后付费CDCPAID：独享集群付费各类型价格请参考云硬盘[价格总览](/document/product/362/2413)。", "example": "PREPAID" }, { "name": "DiskType", "type": "string", "required": true, "description": "硬盘介质类型。取值范围：CLOUD_BASIC：表示普通云硬盘CLOUD_PREMIUM：表示高性能云硬盘CLOUD_SSD：表示SSD云硬盘CLOUD_HSSD：表示增强型SSD云硬盘CLOUD_TSSD：表示极速型SSD云硬盘。", "example": "CLOUD_HSSD" }, { "name": "DiskName", "type": "string", "required": false, "description": "云盘显示名称。不传则默认为“未命名”。最大长度不能超60个字节。", "example": "无" }, { "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": true, "description": "标签值。", "example": "tag-val" } ] }, { "name": "DiskChargePrepaid", "type": "object", "required": false, "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": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费默认取值：NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费。", "example": "NOTIFY_AND_AUTO_RENEW" }, { "name": "CurInstanceDeadline", "type": "string", "required": false, "description": "需要将云盘的到期时间与挂载的子机对齐时，可传入该参数。该参数表示子机当前的到期时间，此时Period如果传入，则表示子机需要续费的时长，云盘会自动按对齐到子机续费后的到期时间续费，示例取值：2018-03-30 20:15:03。", "example": "2018-03-30 20:15:03" } ] }, { "name": "DiskCount", "type": "integer", "required": false, "description": "创建云硬盘数量，不传则默认为1。单次请求最多可创建的云盘数有限制，具体参见[云硬盘使用限制](https://cloud.tencent.com/doc/product/362/5145)。", "example": "1" }, { "name": "ThroughputPerformance", "type": "integer", "required": false, "description": "可选参数。使用此参数可给云硬盘购买额外的性能。当前仅支持极速型云盘（CLOUD_TSSD）和增强型SSD云硬盘（CLOUD_HSSD）", "example": "100" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "云硬盘大小，单位为GB。如果传入`SnapshotId`则可不传`DiskSize`，此时新建云盘的大小为快照大小如果传入`SnapshotId`同时传入`DiskSize`，则云盘大小必须大于或等于快照大小云盘大小取值范围参见云硬盘[产品分类](/document/product/362/2353)的说明。", "example": "500" }, { "name": "Shareable", "type": "boolean", "required": false, "description": "可选参数，默认为False。传入True时，云盘将创建为共享型云盘。", "example": "无" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。", "example": "无" }, { "name": "Encrypt", "type": "string", "required": false, "description": "传入该参数用于创建加密云盘，取值固定为ENCRYPT。", "example": "无" }, { "name": "SnapshotId", "type": "string", "required": false, "description": "快照ID，如果传入则根据此快照创建云硬盘，快照类型必须为数据盘快照，可通过[DescribeSnapshots](/document/product/362/15647)接口查询快照，见输出参数DiskUsage解释。", "example": "无" } ], "required": [ "Placement", "DiskChargeType", "DiskType" ] }, { "name": "CreateHaVip", "description": "本接口（CreateHaVip）用于创建高可用虚拟IP（HAVIP）", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "HAVIP所在私有网络ID。", "example": "vpc-m0c2kcun" }, { "name": "SubnetId", "type": "string", "required": true, "description": "HAVIP所在子网ID。", "example": "subnet-rtmfkg4w" }, { "name": "HaVipName", "type": "string", "required": true, "description": "HAVIP名称。", "example": "demo" }, { "name": "Vip", "type": "string", "required": false, "description": "指定虚拟IP地址，必须在VPC网段内且未被占用。不指定则自动分配。", "example": "10.0.0.2" } ], "required": [ "VpcId", "SubnetId", "HaVipName" ] }, { "name": "CreateImage", "description": "本接口(CreateImage)用于将实例的系统盘制作为新镜像，创建后的镜像可以用于创建实例。", "status": "online", "parameters": [ { "name": "ImageName", "type": "string", "required": true, "description": "镜像名称。" }, { "name": "InstanceId", "type": "string", "required": true, "description": "需要制作镜像的实例ID。" }, { "name": "ImageDescription", "type": "string", "required": false, "description": "镜像描述。" }, { "name": "ForcePoweroff", "type": "string", "required": false, "description": "是否执行强制关机以制作镜像。取值范围： TRUE：表示自动关机后制作镜像 FALSE：表示开机状态制作，目前不支持，需要先手动关机 默认取值：FALSE。" } ], "required": [ "ImageName", "InstanceId" ] }, { "name": "CreateKeyPair", "description": "用于创建一个 OpenSSH RSA 密钥对，可以用于登录 Linux 实例。", "status": "online", "parameters": [ { "name": "KeyName", "type": "string", "required": true, "description": "密钥对名称，可由数字，字母和下划线组成，长度不超过25个字符。", "example": "xxx" } ], "required": [ "KeyName" ] }, { "name": "CreateListener", "description": "创建负载均衡监听器。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID", "example": "lb-f9zyj3kb" }, { "name": "Ports", "type": "array", "required": true, "description": "要将监听器创建到哪些端口，每个端口对应一个新的监听器", "example": "[\"13001\\n\",\"13002\\n\",\"13003\\n\"]", "item_type": "integer" }, { "name": "Protocol", "type": "string", "required": true, "description": "监听器协议： TCP | UDP", "example": "TCP" }, { "name": "ListenerNames", "type": "array", "required": false, "description": "要创建的监听器名称列表，名称与Ports数组按序一一对应，如不需立即命名，则无需提供此参数", "example": "[\"lis0\\n\",\"lis1\\n\"]", "item_type": "string" }, { "name": "HealthCheck", "type": "object", "required": false, "description": "健康检查相关参数", "example": "无", "children": [ { "name": "HealthSwitch", "type": "integer", "required": false, "description": "是否开启健康检查：1（开启）、0（关闭） 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "TimeOut", "type": "integer", "required": false, "description": "健康检查的响应超时时间，可选值：2~60，默认值：2，单位：秒。响应超时时间要小于检查间隔时间。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "IntervalTime", "type": "integer", "required": false, "description": "健康检查探测间隔时间，默认值：5，可选值：5~300，单位：秒。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "HealthNum", "type": "integer", "required": false, "description": "健康阈值，默认值：3，表示当连续探测三次健康则表示该转发正常，可选值：2~10，单位：次。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "UnHealthyNum", "type": "integer", "required": false, "description": "不健康阈值，默认值：3，表示当连续探测三次不健康则表示该转发异常，可选值：2~10，单位：次。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "CheckPort", "type": "integer", "required": false, "description": "自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "ContextType", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查的输入格式，可取值：HEX或TEXT；取值为HEX时，SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "SendContext", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查发送的请求内容，只允许ASCII可见字符，最大长度限制500。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "RecvContext", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查返回的结果，只允许ASCII可见字符，最大长度限制500。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "CheckType", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查使用的协议：TCP | CUSTOM（UDP监听器只支持CUSTOM；如果使用自定义健康检查功能，则必传）。 注意：此字段可能返回 null，表示取不到有效值。" } ] }, { "name": "SessionExpireTime", "type": "integer", "required": false, "description": "会话保持时间，单位：秒。可选值：30~3600，默认 0，表示不开启。此参数仅适用于TCP/UDP监听器。", "example": "60" }, { "name": "Scheduler", "type": "string", "required": false, "description": "监听器转发的方式。可选值：WRR、LEAST_CONN 分别表示按权重轮询、最小连接数， 默认为 WRR。", "example": "WRR" }, { "name": "SessionType", "type": "string", "required": false, "description": "会话保持类型。不传或传NORMAL表示默认会话保持类型。QUIC_CID 表示根据Quic Connection ID做会话保持。QUIC_CID只支持UDP协议。", "example": "NORMAL" }, { "name": "EndPorts", "type": "array", "required": false, "description": "批量端口段的结束端口，必须和Ports长度一样。", "example": "[80,81]", "item_type": "integer" } ], "required": [ "LoadBalancerId", "Ports", "Protocol" ] }, { "name": "CreateLoadBalancer", "description": "购买负载均衡实例。", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM区域，形如ap-xian-ecm。", "example": "ap-hangzhou-ecm" }, { "name": "LoadBalancerType", "type": "string", "required": true, "description": "负载均衡实例的网络类型。目前只支持传入OPEN，表示公网属性。", "example": "OPEN" }, { "name": "VipIsp", "type": "string", "required": true, "description": "CMCC | CTCC | CUCC，分别对应 移动 | 电信 | 联通。", "example": "CUCC" }, { "name": "LoadBalancerName", "type": "string", "required": false, "description": "负载均衡实例的名称，只在创建一个实例的时候才会生效。规则：1-50 个英文、汉字、数字、连接线“-”或下划线“_”。 注意：如果名称与系统中已有负载均衡实例的名称相同，则系统将会自动生成此次创建的负载均衡实例的名称。", "example": "testname" }, { "name": "VpcId", "type": "string", "required": false, "description": "负载均衡后端目标设备所属的网络 ID，如vpc-12345678。", "example": "vpc-12345678" }, { "name": "Number", "type": "integer", "required": false, "description": "创建负载均衡的个数，默认值 1。", "example": "无" }, { "name": "InternetAccessible", "type": "object", "required": false, "description": "负载均衡的带宽限制等信息。", "example": "无", "children": [ { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "最大出带宽，单位Mbps。默认值10", "example": "10" } ] }, { "name": "Tags", "type": "array", "required": false, "description": "标签。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签的键。" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签的值。" } ] }, { "name": "SecurityGroups", "type": "array", "required": false, "description": "安全组。", "example": "无", "item_type": "string" }, { "name": "AddressIPVersion", "type": "string", "required": false, "description": "仅适用于公网负载均衡。IP版本，可取值：IPV4、IPv6FullChain，默认值 IPV4。说明：取值为IPv6FullChain，表示为IPv6版本。", "example": "IPV4" }, { "name": "SubnetId", "type": "string", "required": false, "description": "在购买IPV6负载均衡实例的情况下，必须指定子网 ID, 此参数必填；IPv4实例不支持该参数。", "example": "subnet-dva8****" } ], "required": [ "EcmRegion", "LoadBalancerType", "VipIsp" ] }, { "name": "CreateModule", "description": "创建模块", "status": "online", "parameters": [ { "name": "ModuleName", "type": "string", "required": true, "description": "模块名称，如视频直播模块。限制：模块名称不得以空格开头，长度不得超过60个字符。", "example": "智能语音模块" }, { "name": "DefaultBandWidth", "type": "integer", "required": true, "description": "默认带宽，单位：Mbps。范围不得超过带宽上下限，详看[DescribeConfig](https://cloud.tencent.com/document/product/1108/42572)。", "example": "50" }, { "name": "DefaultImageId", "type": "string", "required": true, "description": "默认镜像。", "example": "img-1tyt4apn" }, { "name": "InstanceType", "type": "string", "required": true, "description": "机型ID。", "example": "SN3ne.2XLARGE16" }, { "name": "DefaultSystemDiskSize", "type": "integer", "required": true, "description": "默认系统盘大小，单位：GB，默认大小为50GB。范围不得超过系统盘上下限制，详看[DescribeConfig](https://cloud.tencent.com/document/product/1108/42572)。", "example": "50" }, { "name": "DefaultDataDiskSize", "type": "integer", "required": true, "description": "默认数据盘大小，单位：GB。范围不得超过数据盘范围大小，详看[DescribeConfig](https://cloud.tencent.com/document/product/1108/42572)。", "example": "100" }, { "name": "CloseIpDirect", "type": "boolean", "required": false, "description": "是否关闭IP直通。取值范围： true：表示关闭IP直通 false：表示开通IP直通", "example": "true" }, { "name": "TagSpecification", "type": "array", "required": false, "description": "标签列表。", "example": "无", "item_type": "object", "children": [ { "name": "ResourceType", "type": "string", "required": true, "description": "资源类型，目前仅支持\"instance\"、\"module\"" }, { "name": "Tags", "type": "array", "required": true, "description": "标签列表", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签健。", "example": "tag-key" }, { "name": "Value", "type": "string", "required": true, "description": "标签值。", "example": "tag-val" } ] } ] }, { "name": "SecurityGroups", "type": "array", "required": false, "description": "模块默认安全组列表", "example": "[\"esg-ggdr123\",\"esg-15fd123\",\"esg-mt9b9123\"]", "item_type": "string" }, { "name": "DefaultBandWidthIn", "type": "integer", "required": false, "description": "默认入带宽，单位：Mbps。范围不得超过带宽上下限，详看[DescribeConfig](https://cloud.tencent.com/document/product/1108/42572)。", "example": "25" }, { "name": "DisableWanIp", "type": "boolean", "required": false, "description": "是否禁止分配外网IP", "example": "true" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "系统盘信息。", "example": "无", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "硬盘类型。取值范围： - LOCAL_BASIC：本地硬盘； - CLOUD_PREMIUM：高性能云硬盘； 默认取值：CLOUD_BASIC。", "example": "CLOUD_PREMIUM" }, { "name": "DiskId", "type": "string", "required": false, "description": "硬盘ID。此参数暂不可用。", "example": "ldisk-1ly4f53h" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "硬盘容量大小。单位GB。", "example": "100" } ] }, { "name": "DataDisks", "type": "array", "required": false, "description": "数据盘信息。", "example": "无", "item_type": "object", "children": [ { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘大小。单位GB。", "example": "100" }, { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型，取值范围： - LOCAL_BASIC：本地硬盘 - CLOUD_PREMIUM：高性能云硬盘 默认取值： LOCAL_BASIC。", "example": "CLOUD_PREMIUM" } ] } ], "required": [ "ModuleName", "DefaultBandWidth", "DefaultImageId", "InstanceType", "DefaultSystemDiskSize", "DefaultDataDiskSize" ] }, { "name": "CreateNetworkInterface", "description": "创建弹性网卡", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。", "example": "vpc-4tw1bxlq" }, { "name": "NetworkInterfaceName", "type": "string", "required": true, "description": "弹性网卡名称，最大长度不能超过60个字节。", "example": "demo" }, { "name": "SubnetId", "type": "string", "required": true, "description": "弹性网卡所在的子网实例ID，例如：subnet-0ap8nwca。", "example": "subnet-6zwa44xm" }, { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域，形如ap-xian-ecm。", "example": "ap-hangzhou-ecm" }, { "name": "NetworkInterfaceDescription", "type": "string", "required": false, "description": "弹性网卡描述，可任意命名，但不得超过60个字符。", "example": "demo" }, { "name": "SecondaryPrivateIpAddressCount", "type": "integer", "required": false, "description": "新申请的内网IP地址个数，内网IP地址个数总和不能超过配额数。", "example": "1" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "指定绑定的安全组，例如：['sg-1dd51d']。", "example": "[\"esg-d5fk1x7n\"]", "item_type": "string" }, { "name": "PrivateIpAddresses", "type": "array", "required": false, "description": "指定的内网IP信息，单次最多指定10个。", "example": "[{\"PrivateIpAddress\": \"10.0.0.11\"}]", "item_type": "object", "children": [ { "name": "PrivateIpAddress", "type": "string", "required": true, "description": "内网IP地址。", "example": "10.0.0.11" }, { "name": "Primary", "type": "boolean", "required": false, "description": "是否是主IP。", "example": "false" }, { "name": "PublicIpAddress", "type": "string", "required": false, "description": "公网IP地址。", "example": "123.11.100.87" }, { "name": "AddressId", "type": "string", "required": false, "description": "EIP实例ID，例如：eip-11112222。", "example": "eip-ms7c7gcr" }, { "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": "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": true, "description": "标签值。", "example": "tag-val" } ] } ], "required": [ "VpcId", "NetworkInterfaceName", "SubnetId", "EcmRegion" ] }, { "name": "CreateRouteTable", "description": "创建了VPC后，系统会创建一个默认路由表，所有新建的子网都会关联到默认路由表。默认情况下您可以直接使用默认路由表来管理您的路由策略。当您的路由策略较多时，您可以调用创建路由表接口创建更多路由表管理您的路由策略。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "待操作的VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。", "example": "vpc-loibq08z" }, { "name": "RouteTableName", "type": "string", "required": true, "description": "路由表名称，最大长度不能超过60个字节。", "example": "测试路由表" }, { "name": "EcmRegion", "type": "string", "required": true, "description": "ecm地域", "example": "ap-hangzhou-ecm" } ], "required": [ "VpcId", "RouteTableName", "EcmRegion" ] }, { "name": "CreateRoutes", "description": "创建路由策略", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表实例ID。", "example": "rtb-n0yejvje" }, { "name": "Routes", "type": "array", "required": true, "description": "要创建的路由策略对象。", "example": "[{\"DestinationCidrBlock\": \"10.2.2.0/24\", \"GatewayType\": \"NAT\", \"GatewayId\": \"nat-irmuq4z4\",\"Enabled\": true}]", "item_type": "object", "children": [ { "name": "DestinationCidrBlock", "type": "string", "required": false, "description": "目的IPv4网段", "example": "10.2.2.0/24" }, { "name": "GatewayType", "type": "string", "required": false, "description": "下一跳类型 NORMAL_CVM：普通云服务器；", "example": "NAT" }, { "name": "GatewayId", "type": "string", "required": false, "description": "下一跳地址 这里只需要指定不同下一跳类型的网关ID，系统会自动匹配到下一跳地址 当 GatewayType 为 EIP 时，GatewayId 固定值 '0'", "example": "nat-irmuq4z4" }, { "name": "RouteItemId", "type": "string", "required": false, "description": "路由策略唯一ID", "example": "rti-mpgivlqt" }, { "name": "RouteDescription", "type": "string", "required": false, "description": "路由策略描述", "example": "TEST" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否启用", "example": "True" }, { "name": "RouteType", "type": "string", "required": false, "description": "路由类型，目前我们支持的类型有： USER：用户路由； NETD：网络探测路由，创建网络探测实例时，系统默认下发，不可编辑与删除； CCN：云联网路由，系统默认下发，不可编辑与删除。 用户只能添加和操作 USER 类型的路由。", "example": "CCN" }, { "name": "RouteId", "type": "integer", "required": false, "description": "路由策略ID。IPv4路由策略ID是有意义的值，IPv6路由策略是无意义的值0。后续建议完全使用字符串唯一ID `RouteItemId`操作路由策略", "example": "1" }, { "name": "RouteTableId", "type": "string", "required": false, "description": "路由表实例ID，例如：rtb-azd4dt1c。", "example": "rtb-azd4dt1c" } ] } ], "required": [ "RouteTableId", "Routes" ] }, { "name": "CreateSecurityGroup", "description": "创建安全组", "status": "online", "parameters": [ { "name": "GroupName", "type": "string", "required": true, "description": "安全组名称，可任意命名，但不得超过60个字符。", "example": "demo" }, { "name": "GroupDescription", "type": "string", "required": true, "description": "安全组备注，最多100个字符。", "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": true, "description": "标签值。", "example": "tag-val" } ] } ], "required": [ "GroupName", "GroupDescription" ] }, { "name": "CreateSecurityGroupPolicies", "description": "本接口（CreateSecurityGroupPolicies）用于创建安全组规则（SecurityGroupPolicy）。 在 SecurityGroupPolicySet 参数中： Version 安全组规则版本号，用户每次更新安全规则版本会自动加1，防止您更新的路由规则已过期，不填不考虑冲突。 在创建出站和入站规则（Egress 和 Ingress）时： Protocol 字段支持输入TCP, UDP, ICMP, GRE, ALL。 CidrBlock 字段允许输入符合cidr格式标准的任意字符串。在基础网络中，...", "status": "online", "parameters": [ { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组实例ID，例如esg-33ocnj9n，可通过DescribeSecurityGroups获取。", "example": "esg-ohuuioma" }, { "name": "SecurityGroupPolicySet", "type": "object", "required": true, "description": "安全组规则集合。", "example": "无", "children": [ { "name": "Version", "type": "string", "required": false, "description": "安全组规则当前版本。用户每次更新安全规则版本会自动加1，防止更新的路由规则已过期，不填不考虑冲突。", "example": "2" }, { "name": "Egress", "type": "array", "required": false, "description": "出站规则。其中出站规则和入站规则必须选一个。", "example": "[{\"PolicyIndex\":1,\"Protocol\":\"tcp\",\"Port\":\"all\",\"CidrBlock\":\"0.0.0.0/0\",\"Action\":\"ACCEPT\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号", "example": "1" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。", "example": "80" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "{\"ServiceId\": \"eppm-f5n1f8da\", \"ServiceGroupId\": \"\"}", "children": [ { "name": "ServiceId", "type": "string", "required": true, "description": "协议端口ID，例如：eppm-f5n1f8da。", "example": "eppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": true, "description": "协议端口组ID，例如：eppmg-f5n1f8da。", "example": "eppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)。", "example": "0.0.0.0/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：esg-ohuuioma。", "example": "esg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者ID地址组ID。", "example": "{\"AddressId\": \"eipm-2uw6ujo6\", \"AddressGroupId\": \"\"}", "children": [ { "name": "AddressId", "type": "string", "required": true, "description": "IP地址ID，例如：eipm-2uw6ujo6。", "example": "eipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": true, "description": "IP地址组ID，例如：eipmg-2uw6ujo6。", "example": "eipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。", "example": "放通90端口" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间，例如 2020-07-22 19：27：23", "example": "2021-05-11 16:46:38" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。 注意：此字段可能返回 null，表示取不到有效值。", "example": "::/0" } ] }, { "name": "Ingress", "type": "array", "required": false, "description": "入站规则。其中出站规则和入站规则必须选一个。", "example": "[{\"PolicyIndex\":1,\"Protocol\":\"tcp\",\"Port\":\"80\",\"CidrBlock\":\"20.0.0.0/16\",\"Action\":\"ACCEPT\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号", "example": "1" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。", "example": "80" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "{\"ServiceId\": \"eppm-f5n1f8da\", \"ServiceGroupId\": \"\"}", "children": [ { "name": "ServiceId", "type": "string", "required": true, "description": "协议端口ID，例如：eppm-f5n1f8da。", "example": "eppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": true, "description": "协议端口组ID，例如：eppmg-f5n1f8da。", "example": "eppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)。", "example": "0.0.0.0/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：esg-ohuuioma。", "example": "esg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者ID地址组ID。", "example": "{\"AddressId\": \"eipm-2uw6ujo6\", \"AddressGroupId\": \"\"}", "children": [ { "name": "AddressId", "type": "string", "required": true, "description": "IP地址ID，例如：eipm-2uw6ujo6。", "example": "eipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": true, "description": "IP地址组ID，例如：eipmg-2uw6ujo6。", "example": "eipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。", "example": "放通90端口" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间，例如 2020-07-22 19：27：23", "example": "2021-05-11 16:46:38" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。 注意：此字段可能返回 null，表示取不到有效值。", "example": "::/0" } ] } ] } ], "required": [ "SecurityGroupId", "SecurityGroupPolicySet" ] }, { "name": "CreateSubnet", "description": "创建子网，若创建成功，则此子网会成为此可用区的默认子网。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "待操作的VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。", "example": "vpc-gunajtt9" }, { "name": "SubnetName", "type": "string", "required": true, "description": "子网名称，最大长度不能超过60个字节。", "example": "demo" }, { "name": "CidrBlock", "type": "string", "required": true, "description": "子网网段，子网网段必须在VPC网段内，相同VPC内子网网段不能重叠。", "example": "10.122.1.0/24" }, { "name": "Zone", "type": "string", "required": true, "description": "子网所在的可用区ID，不同子网选择不同可用区可以做跨可用区灾备。", "example": "ap-hefei-ecm-1" }, { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域", "example": "ap-hefei-ecm" }, { "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": true, "description": "标签值。", "example": "tag-val" } ] }, { "name": "IPv6CidrBlock", "type": "string", "required": false, "description": "IPv6 CIDR", "example": "2409:8c30:141:12::/64" } ], "required": [ "VpcId", "SubnetName", "CidrBlock", "Zone", "EcmRegion" ] }, { "name": "CreateVpc", "description": "创建私有网络", "status": "online", "parameters": [ { "name": "VpcName", "type": "string", "required": true, "description": "vpc名称，最大长度不能超过60个字节。", "example": "demo" }, { "name": "CidrBlock", "type": "string", "required": true, "description": "vpc的cidr，只能为10.*.0.0/16，172.[16-31].0.0/16，192.168.0.0/16这三个内网网段内。", "example": "10.122.0.0/16" }, { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域", "example": "ap-hefei-ecm" }, { "name": "EnableMulticast", "type": "string", "required": false, "description": "是否开启组播。true: 开启, false: 不开启。暂不支持", "example": "true" }, { "name": "DnsServers", "type": "array", "required": false, "description": "DNS地址，最多支持4个，暂不支持", "example": "[\"8.8.8.8\"]", "item_type": "string" }, { "name": "DomainName", "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": true, "description": "标签值。", "example": "tag-val" } ] }, { "name": "Description", "type": "string", "required": false, "description": "描述信息", "example": "demo" }, { "name": "ISPTypes", "type": "array", "required": false, "description": "网络运营商类型 取值范围:'CMCC'-中国移动, 'CTCC'-中国电信, 'CUCC'-中国联调", "example": "[{\"ISPType\":\"BGP\", \"Count\":1}]\t", "item_type": "object", "children": [ { "name": "ISPType", "type": "string", "required": false, "description": "IPv6 Cidr所属运营商类型，支持的类型有 'CMCC'-中国移动, 'CTCC'-中国电信, 'CUCC'-中国联调。作为入参数时为必选。", "example": "CMCC" }, { "name": "Count", "type": "integer", "required": false, "description": "申请IPv6 Cidr Block的个数。作为入参数时为必选。", "example": "1" } ] } ], "required": [ "VpcName", "CidrBlock", "EcmRegion" ] }, { "name": "DeleteHaVip", "description": "用于删除高可用虚拟IP（HAVIP）", "status": "online", "parameters": [ { "name": "HaVipId", "type": "string", "required": true, "description": "HAVIP唯一ID，形如：havip-9o233uri。", "example": "havip-kekyk044" } ], "required": [ "HaVipId" ] }, { "name": "DeleteImage", "description": "删除镜像", "status": "online", "parameters": [ { "name": "ImageIDSet", "type": "array", "required": true, "description": "镜像ID列表。", "item_type": "string" } ], "required": [ "ImageIDSet" ] }, { "name": "DeleteListener", "description": "删除负载均衡监听器。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID" }, { "name": "ListenerId", "type": "string", "required": true, "description": "要删除的监听器 ID" } ], "required": [ "LoadBalancerId", "ListenerId" ] }, { "name": "DeleteLoadBalancer", "description": "删除负载均衡实例。", "status": "online", "parameters": [ { "name": "LoadBalancerIds", "type": "array", "required": false, "description": "要删除的负载均衡实例 ID数组，数组大小最大支持20", "item_type": "string" } ], "required": [] }, { "name": "DeleteLoadBalancerListeners", "description": "删除负载均衡多个监听器", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID" }, { "name": "ListenerIds", "type": "array", "required": false, "description": "指定删除的监听器ID数组，若不填则删除负载均衡的所有监听器", "item_type": "string" } ], "required": [ "LoadBalancerId" ] }, { "name": "DeleteModule", "description": "删除业务模块", "status": "online", "parameters": [ { "name": "ModuleId", "type": "string", "required": true, "description": "模块ID。如：em-qn46snq8" } ], "required": [ "ModuleId" ] }, { "name": "DeleteNetworkInterface", "description": "删除弹性网卡", "status": "online", "parameters": [ { "name": "NetworkInterfaceId", "type": "string", "required": true, "description": "弹性网卡实例ID，例如：eni-m6dyj72l。", "example": "eni-m6dyj72l" }, { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域，形如ap-xian-ecm。", "example": "ap-xian-ecm" } ], "required": [ "NetworkInterfaceId", "EcmRegion" ] }, { "name": "DeleteRouteTable", "description": "删除路由表", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表实例ID，例如：rtb-azd4dt1c", "example": "rtb-azd4dt1c" } ], "required": [ "RouteTableId" ] }, { "name": "DeleteRoutes", "description": "对某个路由表批量删除路由策略", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表唯一ID。", "example": "rtb-12345678" }, { "name": "Routes", "type": "array", "required": true, "description": "路由策略对象。", "example": "无", "item_type": "object", "children": [ { "name": "DestinationCidrBlock", "type": "string", "required": false, "description": "目的IPv4网段", "example": "10.2.2.0/24" }, { "name": "GatewayType", "type": "string", "required": false, "description": "下一跳类型 NORMAL_CVM：普通云服务器；", "example": "NAT" }, { "name": "GatewayId", "type": "string", "required": false, "description": "下一跳地址 这里只需要指定不同下一跳类型的网关ID，系统会自动匹配到下一跳地址 当 GatewayType 为 EIP 时，GatewayId 固定值 '0'", "example": "nat-irmuq4z4" }, { "name": "RouteItemId", "type": "string", "required": false, "description": "路由策略唯一ID", "example": "rti-mpgivlqt" }, { "name": "RouteDescription", "type": "string", "required": false, "description": "路由策略描述", "example": "TEST" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否启用", "example": "True" }, { "name": "RouteType", "type": "string", "required": false, "description": "路由类型，目前我们支持的类型有： USER：用户路由； NETD：网络探测路由，创建网络探测实例时，系统默认下发，不可编辑与删除； CCN：云联网路由，系统默认下发，不可编辑与删除。 用户只能添加和操作 USER 类型的路由。", "example": "CCN" }, { "name": "RouteId", "type": "integer", "required": false, "description": "路由策略ID。IPv4路由策略ID是有意义的值，IPv6路由策略是无意义的值0。后续建议完全使用字符串唯一ID `RouteItemId`操作路由策略", "example": "1" }, { "name": "RouteTableId", "type": "string", "required": false, "description": "路由表实例ID，例如：rtb-azd4dt1c。", "example": "rtb-azd4dt1c" } ] } ], "required": [ "RouteTableId", "Routes" ] }, { "name": "DeleteSecurityGroup", "description": "只有当前账号下的安全组允许被删除。 安全组实例ID如果在其他安全组的规则中被引用，则无法直接删除。这种情况下，需要先进行规则修改，再删除安全组。 删除的安全组无法再找回，请谨慎调用。", "status": "online", "parameters": [ { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组实例ID，例如esg-33ocnj9n，可通过DescribeSecurityGroups获取。", "example": "esg-33ocnj9n" } ], "required": [ "SecurityGroupId" ] }, { "name": "DeleteSecurityGroupPolicies", "description": "SecurityGroupPolicySet.Version 用于指定要操作的安全组的版本。传入 Version 版本号若不等于当前安全组的最新版本，将返回失败；若不传 Version 则直接删除指定PolicyIndex的规则。", "status": "online", "parameters": [ { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组实例ID，例如esg-33ocnj9n，可通过DescribeSecurityGroups获取。", "example": "esg-33ocnj9n" }, { "name": "SecurityGroupPolicySet", "type": "object", "required": true, "description": "安全组规则集合。一个请求中只能删除单个方向的一条或多条规则。支持指定索引（PolicyIndex） 匹配删除和安全组规则匹配删除两种方式，一个请求中只能使用一种匹配方式。", "example": "{\"Ingress\": [{\"CidrBlock\": \"10.0.0.0/16\", \"Protocol\": \"tcp\", \"Port\": \"80\", \"Action\": \"accept\"}]}", "children": [ { "name": "Version", "type": "string", "required": false, "description": "安全组规则当前版本。用户每次更新安全规则版本会自动加1，防止更新的路由规则已过期，不填不考虑冲突。", "example": "2" }, { "name": "Egress", "type": "array", "required": false, "description": "出站规则。其中出站规则和入站规则必须选一个。", "example": "[{\"PolicyIndex\":1,\"Protocol\":\"tcp\",\"Port\":\"all\",\"CidrBlock\":\"0.0.0.0/0\",\"Action\":\"ACCEPT\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号", "example": "1" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。", "example": "80" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "{\"ServiceId\": \"eppm-f5n1f8da\", \"ServiceGroupId\": \"\"}", "children": [ { "name": "ServiceId", "type": "string", "required": true, "description": "协议端口ID，例如：eppm-f5n1f8da。", "example": "eppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": true, "description": "协议端口组ID，例如：eppmg-f5n1f8da。", "example": "eppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)。", "example": "0.0.0.0/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：esg-ohuuioma。", "example": "esg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者ID地址组ID。", "example": "{\"AddressId\": \"eipm-2uw6ujo6\", \"AddressGroupId\": \"\"}", "children": [ { "name": "AddressId", "type": "string", "required": true, "description": "IP地址ID，例如：eipm-2uw6ujo6。", "example": "eipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": true, "description": "IP地址组ID，例如：eipmg-2uw6ujo6。", "example": "eipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。", "example": "放通90端口" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间，例如 2020-07-22 19：27：23", "example": "2021-05-11 16:46:38" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。 注意：此字段可能返回 null，表示取不到有效值。", "example": "::/0" } ] }, { "name": "Ingress", "type": "array", "required": false, "description": "入站规则。其中出站规则和入站规则必须选一个。", "example": "[{\"PolicyIndex\":1,\"Protocol\":\"tcp\",\"Port\":\"80\",\"CidrBlock\":\"20.0.0.0/16\",\"Action\":\"ACCEPT\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号", "example": "1" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。", "example": "80" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "{\"ServiceId\": \"eppm-f5n1f8da\", \"ServiceGroupId\": \"\"}", "children": [ { "name": "ServiceId", "type": "string", "required": true, "description": "协议端口ID，例如：eppm-f5n1f8da。", "example": "eppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": true, "description": "协议端口组ID，例如：eppmg-f5n1f8da。", "example": "eppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)。", "example": "0.0.0.0/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：esg-ohuuioma。", "example": "esg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者ID地址组ID。", "example": "{\"AddressId\": \"eipm-2uw6ujo6\", \"AddressGroupId\": \"\"}", "children": [ { "name": "AddressId", "type": "string", "required": true, "description": "IP地址ID，例如：eipm-2uw6ujo6。", "example": "eipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": true, "description": "IP地址组ID，例如：eipmg-2uw6ujo6。", "example": "eipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。", "example": "放通90端口" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间，例如 2020-07-22 19：27：23", "example": "2021-05-11 16:46:38" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。 注意：此字段可能返回 null，表示取不到有效值。", "example": "::/0" } ] } ] } ], "required": [ "SecurityGroupId", "SecurityGroupPolicySet" ] }, { "name": "DeleteSnapshots", "description": "CBS在ECM早已下线 本接口（DeleteSnapshots）用于删除快照。 * 快照必须处于NORMAL状态，快照状态可以通过[DescribeSnapshots](/document/product/362/15647)接口查询，见输出参数中SnapshotState字段解释。 * 支持批量操作。如果多个快照存在无法删除的快照，则操作不执行，以返回特定的错误码返回。", "status": "deprecated", "parameters": [ { "name": "SnapshotIds", "type": "array", "required": true, "description": "要删除的快照ID列表，可通过[DescribeSnapshots](/document/product/362/15647)查询。", "example": "[\"snap-gybrif0z\\n\"]", "item_type": "string" }, { "name": "DeleteBindImages", "type": "boolean", "required": false, "description": "是否强制删除快照关联的镜像", "example": "true" } ], "required": [ "SnapshotIds" ] }, { "name": "DeleteSubnet", "description": "删除子网，若子网为可用区下的默认子网，则默认子网会回退到系统自动创建的默认子网，非用户最新创建的子网。若默认子网不满足需求，可调用设置默认子网接口设置。", "status": "online", "parameters": [ { "name": "SubnetId", "type": "string", "required": true, "description": "子网实例ID。可通过DescribeSubnets接口返回值中的SubnetId获取。", "example": "subnet-jxa0xg1o" }, { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域", "example": "ap-hangzhou-ecm" } ], "required": [ "SubnetId", "EcmRegion" ] }, { "name": "DeleteVpc", "description": "删除私有网络", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC实例ID。可通过DescribeVpcs接口返回值中的VpcId获取。", "example": "vpc-ila64qtl" }, { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域", "example": "ap-hangzhou-ecm" } ], "required": [ "VpcId", "EcmRegion" ] }, { "name": "DescribeAddressQuota", "description": "查询您账户的弹性公网IP（简称 EIP）在当前地域的配额信息", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域", "example": "ap-hangzhou-ecm" } ], "required": [ "EcmRegion" ] }, { "name": "DescribeAddresses", "description": "查询弹性公网IP列表", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域", "example": "ap-chongqing-ecm2" }, { "name": "AddressIds", "type": "array", "required": false, "description": "标识 EIP 的唯一 ID 列表。EIP 唯一 ID 形如：eip-11112222。参数不支持同时指定AddressIds和Filters。", "example": "[\"eip-aihfuscm\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "每次请求的Filters的上限为10，Filter.Values的上限为5。参数不支持同时指定AddressIds和Filters。详细的过滤条件如下： address-id - String - 是否必填：否 - （过滤条件）按照 EIP 的唯一 ID 过滤。EIP 唯一 ID 形如：eip-11112222。 address-name - String - 是否必填：否 - （过滤条件）按照 EIP 名称过滤。不支持模糊过滤。 address-ip - String - 是否必填：否 - （过滤条件）按照 EIP 的 IP 地址过滤。 address-s...", "example": "无", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"V0\", \"V1\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "\"FilterName\"" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" } ], "required": [ "EcmRegion" ] }, { "name": "DescribeBaseOverview", "description": "获取概览页统计的基本数据", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeConfig", "description": "获取带宽硬盘等数据的限制", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeCustomImageTask", "description": "查询导入镜像任务", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": true, "description": "支持key,value查询 task-id: 异步任务ID image-id: 镜像ID image-name: 镜像名称", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"V0\", \"V1\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "\"FilterName\"" } ] } ], "required": [ "Filters" ] }, { "name": "DescribeDefaultSubnet", "description": "查询可用区的默认子网", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM地域", "example": "ap-hangzhou-ecm" }, { "name": "Zone", "type": "string", "required": true, "description": "ECM可用区", "example": "ap-hangzhou-ecm-1" } ], "required": [ "EcmRegion", "Zone" ] }, { "name": "DescribeDisks", "description": "CBS在ECM早已下线 本接口（DescribeDisks）用于查询云硬盘列表。 * 可以根据云硬盘ID、云硬盘类型或者云硬盘状态等信息来查询云硬盘的详细信息，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。 * 如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的云硬盘列表。", "status": "deprecated", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。参数不支持同时指定`DiskIds`和`Filters`。disk-usage - Array of String - 是否必填：否 -（过滤条件）按云盘类型过滤。 (SYSTEM_DISK：表示系统盘 | DATA_DISK：表示数据盘)disk-charge-type - Array of String - 是否必填：否 -（过滤条件）按照云硬盘计费模式过滤。 (PREPAID：表示预付费，即包年包月 | POSTPAID_BY_HOUR：表示后付费，即按量计费。)portable - Array of String - 是否必填：否 -（过滤条件...", "example": "无", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"V0\", \"V1\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "\"FilterName\"" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。", "example": "20" }, { "name": "OrderField", "type": "string", "required": false, "description": "云盘列表排序的依据字段。取值范围：CREATE_TIME：依据云盘的创建时间排序DEADLINE：依据云盘的到期时间排序默认按云盘创建时间排序。", "example": "CREATE_TIME" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。", "example": "0" }, { "name": "ReturnBindAutoSnapshotPolicy", "type": "boolean", "required": false, "description": "云盘详情中是否需要返回云盘绑定的定期快照策略ID，TRUE表示需要返回，FALSE表示不返回。", "example": "FALSE" }, { "name": "DiskIds", "type": "array", "required": false, "description": "按照一个或者多个云硬盘ID查询。云硬盘ID形如：`disk-11112222`，此参数的具体格式可参考API[简介](/document/product/362/15633)的ids.N一节）。参数不支持同时指定`DiskIds`和`Filters`。", "example": "[\"disk-xxxxxxxx\"]", "item_type": "string" }, { "name": "Order", "type": "string", "required": false, "description": "输出云盘列表的排列顺序。取值范围：ASC：升序排列DESC：降序排列。", "example": "ASC" } ], "required": [] }, { "name": "DescribeHaVips", "description": "用于查询高可用虚拟IP（HAVIP）列表。", "status": "online", "parameters": [ { "name": "HaVipIds", "type": "array", "required": false, "description": "HAVIP数组，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。", "example": "[{\"Name\": \"vpc-id\", \"Values\": [\"vpc-ms7c7gcr\"]}]", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"V0\", \"V1\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "\"FilterName\"" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值是0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认值是20，最大是100。", "example": "10" }, { "name": "EcmRegion", "type": "string", "required": false, "description": "Ecm 区域，不填代表全部区域。", "example": "1" } ], "required": [] }, { "name": "DescribeImage", "description": "展示镜像列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，每次请求的Filters的上限为10，详细的过滤条件如下： image-id - String - 是否必填： 否 - （过滤条件）按照镜像ID进行过滤 image-type - String - 是否必填： 否 - （过滤条件）按照镜像类型进行过滤。取值范围： PRIVATE_IMAGE: 私有镜像 (本账户创建的镜像) PUBLIC_IMAGE: 公共镜像 (腾讯云官方镜像) instance-type -String - 是否必填: 否 - (过滤条件) 按机型过滤支持的镜像 image-name - String -...", "example": "无", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"V0\", \"V1\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "\"FilterName\"" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。", "example": "10" } ], "required": [] }, { "name": "DescribeImportImageOs", "description": "查询外部导入镜像支持的OS列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeInstanceTypeConfig", "description": "获取机型配置列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeInstanceVncUrl", "description": "查询实例管理终端地址", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "一个操作的实例ID。可通过DescribeInstances API返回值中的InstanceId获取。" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstances", "description": "获取实例的相关信息。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 zone String 是否必填：否 （过滤条件）按照可用区英文标识符过滤。 zone-name String 是否必填：否 （过滤条件）按照可用区中文名过滤,支持模糊匹配。 module-id String 是否必填：否 （过滤条件）按照模块ID过滤。 instance-id String 是否必填：否 （过滤条件）按照实例ID过滤。 instance-name String 是否必填：否 （过滤条件）按照实例名称过滤,支持模糊匹配。 ip-address String 是否\ufffd...", "example": "{\"Filters\":[{\"Values\":[\"ap-ningbo-ecm2-1\"],\"Name\":\"zone\"}]}", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"V0\", \"V1\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "\"FilterName\"" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "10" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20(如果查询结果数目大于等于20)，最大值为100。", "example": "10" }, { "name": "OrderByField", "type": "string", "required": false, "description": "指定排序字段。目前支持的可选值如下 timestamp 按实例创建时间排序。 注意：目前仅支持按创建时间排序，后续可能会有扩展。 如果不传，默认按实例创建时间排序", "example": "timestamp" }, { "name": "OrderDirection", "type": "integer", "required": false, "description": "指定排序是降序还是升序。0表示降序； 1表示升序。如果不传默认为降序", "example": "0" } ], "required": [] }, { "name": "DescribeInstancesDeniedActions", "description": "通过实例id获取当前禁止的操作", "status": "online", "parameters": [ { "name": "InstanceIdSet", "type": "array", "required": true, "description": "无", "item_type": "string" } ], "required": [ "InstanceIdSet" ] }, { "name": "DescribeListeners", "description": "查询负载均衡的监听器列表。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID" }, { "name": "ListenerIds", "type": "array", "required": false, "description": "要查询的负载均衡监听器 ID数组", "item_type": "string" }, { "name": "Protocol", "type": "string", "required": false, "description": "要查询的监听器协议类型，取值 TCP | UDP" }, { "name": "Port", "type": "integer", "required": false, "description": "要查询的监听器的端口" } ], "required": [ "LoadBalancerId" ] }, { "name": "DescribeLoadBalanceTaskStatus", "description": "查询负载均衡相关的任务状态", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "请求ID，即接口返回的 RequestId 参数" } ], "required": [ "TaskId" ] }, { "name": "DescribeLoadBalancers", "description": "查询负载均衡实例列表。", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": false, "description": "区域。如果不传则默认查询所有区域。" }, { "name": "LoadBalancerIds", "type": "array", "required": false, "description": "负载均衡实例 ID。", "item_type": "string" }, { "name": "LoadBalancerName", "type": "string", "required": false, "description": "负载均衡实例的名称。" }, { "name": "LoadBalancerVips", "type": "array", "required": false, "description": "负载均衡实例的 VIP 地址，支持多个。", "item_type": "string" }, { "name": "BackendPrivateIps", "type": "array", "required": false, "description": "负载均衡绑定的后端服务的内网 IP。", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "数据偏移量，默认为 0。" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回负载均衡实例的数量，默认为20，最大值为100。" }, { "name": "WithBackend", "type": "integer", "required": false, "description": "负载均衡是否绑定后端服务，0：没有绑定后端服务，1：绑定后端服务，-1：查询全部。 如果不传则默认查询全部。" }, { "name": "VpcId", "type": "string", "required": false, "description": "负载均衡实例所属私有网络唯一ID，如 vpc-bhqkbhdx。" }, { "name": "Filters", "type": "array", "required": false, "description": "每次请求的`Filters`的上限为10，`Filter.Values`的上限为100。详细的过滤条件如下： tag-key - String - 是否必填：否 - （过滤条件）按照标签的键过滤。", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"V0\", \"V1\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "\"FilterName\"" } ] }, { "name": "SecurityGroup", "type": "string", "required": false, "description": "安全组。" } ], "required": [] }, { "name": "DescribeModule", "description": "获取模块列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 module-name - string - 是否必填：否 - （过滤条件）按照模块名称过滤。 module-id - string - 是否必填：否 - （过滤条件）按照模块ID过滤。 image-id String 是否必填：否 （过滤条件）按照镜像ID过滤。 instance-family String 是否必填：否 （过滤条件）按照机型family过滤。 security-group-id - string 是否必填：否 - （过滤条件）按照模块绑定的安全组id过滤。 每次请求的Filters的上限为10\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"V0\", \"V1\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "\"FilterName\"" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。", "example": "10" }, { "name": "OrderByField", "type": "string", "required": false, "description": "指定排序字段。目前支持的可选值如下 instance-num 按实例数量排序。 node-num 按节点数量排序。 timestamp 按实例创建时间排序。 如果不传，默认按实例创建时间排序", "example": "timestamp" }, { "name": "OrderDirection", "type": "integer", "required": false, "description": "指定排序是降序还是升序。0表示降序； 1表示升序。如果不传默认为降序", "example": "0" } ], "required": [] }, { "name": "DescribeModuleDetail", "description": "展示模块详细信息", "status": "online", "parameters": [ { "name": "ModuleId", "type": "string", "required": true, "description": "模块ID，如em-qn46snq8。" } ], "required": [ "ModuleId" ] }, { "name": "DescribeMonthPeakNetwork", "description": "获取客户节点上的出入带宽月峰和计费带宽信息", "status": "online", "parameters": [ { "name": "Month", "type": "string", "required": true, "description": "月份时间(xxxx-xx) 如2021-03,默认取当前时间的上一个月份", "example": "2021-03" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件", "example": "Filters", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"V0\", \"V1\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "\"FilterName\"" } ] } ], "required": [ "Month" ] }, { "name": "DescribeNetworkInterfaces", "description": "查询弹性网卡列表", "status": "online", "parameters": [ { "name": "NetworkInterfaceIds", "type": "array", "required": false, "description": "弹性网卡实例ID查询。形如：eni-pxir56ns。每次请求的实例的上限为100。参数不支持同时指定NetworkInterfaceIds和Filters。", "example": "[\"eni-4tw1bxlq\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定NetworkInterfaceIds和Filters。 vpc-id - String - （过滤条件）VPC实例ID，形如：vpc-f49l6u0z。 subnet-id - String - （过滤条件）所属子网实例ID，形如：subnet-f49l6u0z。 network-interface-id - String - （过滤条件）弹性网卡实例ID，形如：eni-5k56k7k7。 attachment.instance-id - String - （过滤条件）绑定的云服务器实例ID，形如：ein-3nqpdn3i。 groups.security-group-id - String - （过滤条件\ufffd\ufffd...", "example": "[{\"Name\": \"vpc-id\", \"Values\": [\"vpc-ms7c7gcr\"]}]", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"V0\", \"V1\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "\"FilterName\"" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" }, { "name": "EcmRegion", "type": "string", "required": false, "description": "ECM 地域，形如ap-xian-ecm。", "example": "ap-hefei-ecm" } ], "required": [] }, { "name": "DescribeNode", "description": "获取节点列表", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，name取值为： InstanceFamily-实例系列", "example": "无", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"V0\", \"V1\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "\"FilterName\"" } ] } ], "required": [] }, { "name": "DescribePackingQuotaGroup", "description": "使用本接口获取某种机型在某些区域的装箱配额（当使用虚拟机型时，返回的是一组相互关联的装箱配额）。", "status": "online", "parameters": [ { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，name取值为：Zone-可用区， InstanceType-实例类型，DataDiskSize - 数据盘大小", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"V0\", \"V1\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "\"FilterName\"" } ] } ], "required": [] }, { "name": "DescribePeakBaseOverview", "description": "CPU 内存 硬盘等基础信息峰值数据", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": false, "description": "开始时间（xxxx-xx-xx）如2019-08-14，默认为一周之前的日期，不应与当前日期间隔超过90天。" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间（xxxx-xx-xx）如2019-08-14，默认为昨天，不应与当前日期间隔超过90天。当开始与结束间隔不超过30天时返回1小时粒度的数据，否则返回3小时粒度的数据。" } ], "required": [] }, { "name": "DescribePeakNetworkOverview", "description": "获取网络峰值数据", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": false, "description": "开始时间（xxxx-xx-xx）如2019-08-14，默认为一周之前的日期，不应与当前日期间隔超过30天。", "example": "2019-08-14" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间（xxxx-xx-xx）如2019-08-14，默认为昨天，不应与当前日期间隔超过30天。当开始与结束间隔不超过1天时会返回1分钟粒度的数据，不超过7天时返回5分钟粒度的数据，否则返回1小时粒度的数据。", "example": "2019-08-14" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。 region String 是否必填：否 （过滤条件）按照region过滤，不支持模糊匹配。注意 region 填上需要查询ecm region才能返回数据。 area String 是否必填：否 （过滤条件）按照大区过滤，不支持模糊匹配。大区包括：china-central、china-east等等，可以通过DescribeNode获得所有大区；也可使用ALL_REGION表示所有地区。 isp String 是否必填：否 （过滤条件）按照运营商过滤大区流量，运营\ufffd...", "example": "Filters", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"V0\", \"V1\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "\"FilterName\"" } ] }, { "name": "Period", "type": "integer", "required": false, "description": "统计周期，单位秒。取值60/300。", "example": "30" } ], "required": [] }, { "name": "DescribePriceRunInstance", "description": "查询实例价格", "status": "online", "parameters": [ { "name": "InstanceType", "type": "string", "required": true, "description": "实例的机型信息", "example": "SN3ne.LARGE8" }, { "name": "SystemDisk", "type": "object", "required": true, "description": "系统盘信息", "example": "无", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "硬盘类型。取值范围： - LOCAL_BASIC：本地硬盘； - CLOUD_PREMIUM：高性能云硬盘； 默认取值：CLOUD_BASIC。", "example": "CLOUD_PREMIUM" }, { "name": "DiskId", "type": "string", "required": false, "description": "硬盘ID。此参数暂不可用。", "example": "ldisk-1ly4f53h" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "硬盘容量大小。单位GB。", "example": "100" } ] }, { "name": "InstanceCount", "type": "integer", "required": true, "description": "实例个数", "example": "1" }, { "name": "DataDisk", "type": "array", "required": false, "description": "数据盘信息", "example": "无", "item_type": "object", "children": [ { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘大小。单位GB。", "example": "100" }, { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型，取值范围： - LOCAL_BASIC：本地硬盘 - CLOUD_PREMIUM：高性能云硬盘 默认取值： LOCAL_BASIC。", "example": "CLOUD_PREMIUM" } ] }, { "name": "InstanceChargeType", "type": "integer", "required": false, "description": "实例计费类型。其中： 0，按资源维度后付费，计算当日用量峰值，例如CPU，内存，硬盘等，仅适用于非GNR系列机型； 1，按小时后付费，单价：xx元/实例/小时，仅适用于GNR机型，如需开通该计费方式请提工单申请； 2，按月后付费，单价：xx元/实例/月，仅适用于GNR机型； 该字段不填时，非GNR机型会默认选择0；GNR机型默认选择2。", "example": "0" } ], "required": [ "InstanceType", "SystemDisk", "InstanceCount" ] }, { "name": "DescribeRegionIpv6Addresses", "description": "该接口（DescribeRegionIpv6Addresses）用于查询ECM地域之下的IPV6地址信息。", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域，为空时返回所有地域的IPv6地址。", "example": "ap-qingdao-ecm" }, { "name": "Filters", "type": "array", "required": false, "description": "详细的过滤条件如下： address-id - String - 是否必填：否 - （过滤条件）按照 EIP 的 ID 过滤。 address-ip - String - 是否必填：否 - （过滤条件）按照 EIP 的 IP 地址过滤。 network-interface-id - String - 是否必填：否 - （过滤条件）按照弹性网卡的唯一ID过滤。 instance-id - String - 是否必填：否 - （过滤条件）按照 EIP 所绑定的实例 ID 过滤。 vpc-id - String - 是否必填：否 - （过滤条件）按照 EIP \ufffd\ufffd...", "example": "无", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"V0\", \"V1\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "\"FilterName\"" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。", "example": "0" } ], "required": [ "EcmRegion" ] }, { "name": "DescribeRouteConflicts", "description": "查询自定义路由策略与云联网路由策略冲突列表", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表实例ID，例如：rtb-azd4dt1c。", "example": "rtb-q8o2z892" }, { "name": "DestinationCidrBlocks", "type": "array", "required": true, "description": "要检查的与之冲突的目的端列表", "example": "[\"10.11.0.0/24\"]", "item_type": "string" } ], "required": [ "RouteTableId", "DestinationCidrBlocks" ] }, { "name": "DescribeRouteTables", "description": "查询路由表对象列表", "status": "online", "parameters": [ { "name": "RouteTableIds", "type": "array", "required": false, "description": "路由表实例ID，例如：rtb-azd4dt1c。", "example": "[\"rtb-azd4dt1c\"]", "item_type": "string" }, { "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 - （过滤条件）是否主路由表。", "example": "[{\"Name\": \"route-table-id\", \"Values\": [\"rtb-ms7c7gcr\"]}]", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"V0\", \"V1\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "\"FilterName\"" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限数", "example": "10" }, { "name": "EcmRegion", "type": "string", "required": false, "description": "ECM 地域，传空或不传表示所有区域", "example": "ap-hangzhou-ecm" } ], "required": [] }, { "name": "DescribeSecurityGroupAssociationStatistics", "description": "查询安全组关联实例统计", "status": "online", "parameters": [ { "name": "SecurityGroupIds", "type": "array", "required": true, "description": "安全实例ID，例如esg-33ocnj9n，可通过[DescribeSecurityGroups](https://cloud.tencent.com/document/product/1108/47697)获取。", "example": "[\"esg-ohuuioma\"]", "item_type": "string" } ], "required": [ "SecurityGroupIds" ] }, { "name": "DescribeSecurityGroupLimits", "description": "查询用户安全组配额", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeSecurityGroupPolicies", "description": "查询安全组规则", "status": "online", "parameters": [ { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组实例ID，例如：esg-33ocnj9n，可通过[DescribeSecurityGroups](https://cloud.tencent.com/document/product/1108/47697)获取。", "example": "esg-4tw1bxlq" } ], "required": [ "SecurityGroupId" ] }, { "name": "DescribeSecurityGroups", "description": "查看安全组", "status": "online", "parameters": [ { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "安全组实例ID，例如：esg-33ocnj9n，可通过[DescribeSecurityGroups](https://cloud.tencent.com/document/product/1108/47697)获取。每次请求的实例的上限为100。参数不支持同时指定SecurityGroupIds和Filters。", "example": "[\"esg-fcx8o80o\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定SecurityGroupIds和Filters。 security-group-id - String - （过滤条件）安全组ID。 security-group-name - String - （过滤条件）安全组名称。 tag-key - String -是否必填：否- （过滤条件）按照标签键进行过滤。 tag:tag-key - String - 是否必填：否 - （过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。", "example": "[{\"Name\": \"tag-key\", \"Values\": [\"env\"]}]", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"V0\", \"V1\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "\"FilterName\"" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。", "example": "20" } ], "required": [] }, { "name": "DescribeSnapshots", "description": "CBS在ECM早已下线 本接口（DescribeSnapshots）用于查询快照的详细信息。 * 根据快照ID、创建快照的云硬盘ID、创建快照的云硬盘类型等对结果进行过滤，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。 * 如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的快照列表。", "status": "deprecated", "parameters": [ { "name": "SnapshotIds", "type": "array", "required": false, "description": "要查询快照的ID列表。参数不支持同时指定`SnapshotIds`和`Filters`。", "example": "无", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件。参数不支持同时指定`SnapshotIds`和`Filters`。snapshot-id - Array of String - 是否必填：否 -（过滤条件）按照快照的ID过滤。快照ID形如：`snap-11112222`。snapshot-name - Array of String - 是否必填：否 -（过滤条件）按照快照名称过滤。snapshot-state - Array of String - 是否必填：否 -（过滤条件）按照快照状态过滤。 (NORMAL：正常 | CREATING：创建中 | ROLLBACKING：回滚中。)disk-usage - Array of String -...", "example": "无", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"V0\", \"V1\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "\"FilterName\"" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API [简介](/document/product/362/15633)中的相关小节。", "example": "无" }, { "name": "OrderField", "type": "string", "required": false, "description": "快照列表排序的依据字段。取值范围：CREATE_TIME：依据快照的创建时间排序默认按创建时间排序。", "example": "无" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0。关于`Offset`的更进一步介绍请参考API[简介](/document/product/362/15633)中的相关小节。", "example": "无" }, { "name": "Order", "type": "string", "required": false, "description": "输出云盘列表的排列顺序。取值范围：ASC：升序排列DESC：降序排列。", "example": "无" } ], "required": [] }, { "name": "DescribeSubnets", "description": "查询子网列表", "status": "online", "parameters": [ { "name": "SubnetIds", "type": "array", "required": false, "description": "子网实例ID查询。形如：subnet-pxir56ns。每次请求的实例的上限为100。参数不支持同时指定SubnetIds和Filters。", "example": "[\"subnet-4tw1bxlq\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定SubnetIds和Filters。 subnet-id - String - Subnet实例名称。 subnet-name - String - 子网名称。只支持单值的模糊查询。 cidr-block - String - 子网网段，形如: 192.168.1.0 。只支持单值的模糊查询。 vpc-id - String - VPC实例ID，形如：vpc-f49l6u0z。 vpc-cidr-block - String - vpc网段，形如: 192.168.1.0 。只支持单值的模糊查询。 region - String - ECM地域 zone - String - 可用区。 tag-key - String ...", "example": "[{\"Name\": \"tag-key\", \"Values\": [\"env\"]}]", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"V0\", \"V1\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "\"FilterName\"" } ] }, { "name": "Offset", "type": "string", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "string", "required": false, "description": "返回数量", "example": "10" }, { "name": "EcmRegion", "type": "string", "required": false, "description": "ECM 地域", "example": "ap-hefei-ecm" }, { "name": "Sort", "type": "string", "required": false, "description": "排序方式：time时间倒序, default按照网络规划排序", "example": "default" } ], "required": [] }, { "name": "DescribeTargetHealth", "description": "获取负载均衡后端服务的健康检查状态。", "status": "online", "parameters": [ { "name": "LoadBalancerIds", "type": "array", "required": true, "description": "要查询的负载均衡实例 ID列表", "item_type": "string" } ], "required": [ "LoadBalancerIds" ] }, { "name": "DescribeTargets", "description": "查询负载均衡绑定的后端服务列表。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID" }, { "name": "ListenerIds", "type": "array", "required": false, "description": "监听器 ID列表", "item_type": "string" }, { "name": "Protocol", "type": "integer", "required": false, "description": "监听器协议类型" }, { "name": "Port", "type": "integer", "required": false, "description": "监听器端口" } ], "required": [ "LoadBalancerId" ] }, { "name": "DescribeTaskResult", "description": "查询EIP异步任务执行结果", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域", "example": "ap-hangzhou-ecm" }, { "name": "TaskId", "type": "string", "required": true, "description": "异步任务ID。", "example": "1528600" } ], "required": [ "EcmRegion", "TaskId" ] }, { "name": "DescribeTaskStatus", "description": "本接口(DescribeTaskStatus)用于获取异步任务状态", "status": "online", "parameters": [ { "name": "TaskSet", "type": "array", "required": true, "description": "任务描述", "example": "无", "item_type": "object", "children": [ { "name": "Operation", "type": "string", "required": true, "description": "操作名，即API名称，比如：CreateImage" }, { "name": "TaskId", "type": "string", "required": true, "description": "任务id" } ] } ], "required": [ "TaskSet" ] }, { "name": "DescribeVpcs", "description": "查询私有网络列表", "status": "online", "parameters": [ { "name": "VpcIds", "type": "array", "required": false, "description": "VPC实例ID。形如：vpc-f49l6u0z。每次请求的实例的上限为100。参数不支持同时指定VpcIds和Filters。", "example": "[\"vpc-4tw1bxlq\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件，参数不支持同时指定VpcIds和Filters。 vpc-name - String - VPC实例名称，只支持单值的模糊查询。 vpc-id - String - VPC实例ID形如：vpc-f49l6u0z。 cidr-block - String - vpc的cidr，只支持单值的模糊查询。 region - String - vpc的region。 tag-key - String -是否必填：否- 按照标签键进行过滤。 tag:tag-key - String - 是否必填：否 - 按照标签键值对进行过滤。 ipv6-cidr-block - String - 是否必填：否 - 按照IPv6 ...", "example": "[{\"Name\": \"tag-key\", \"Values\": [\"env\"]}]", "item_type": "object", "children": [ { "name": "Values", "type": "array", "required": true, "description": "一个或者多个过滤值。", "example": "[\"V0\", \"V1\"]", "item_type": "string" }, { "name": "Name", "type": "string", "required": true, "description": "过滤键的名称。", "example": "\"FilterName\"" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回数量", "example": "10" }, { "name": "EcmRegion", "type": "string", "required": false, "description": "地域", "example": "ap-hefei-ecm" }, { "name": "Sort", "type": "string", "required": false, "description": "排序方式：time时间倒序, default按照网络规划排序", "example": "default" } ], "required": [] }, { "name": "DetachDisks", "description": "CBS在ECM早已下线 本接口（DetachDisks）用于卸载云硬盘。 * 支持批量操作，卸载挂载在同一主机上的多块云盘。如果多块云盘中存在不允许卸载的云盘，则操作不执行，返回特定的错误码。 * 本接口为异步接口，当请求成功返回时，云盘并未立即从主机卸载，可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态，如果云盘的状态由“ATTACHED”变为“UNATTACHED”，则为...", "status": "deprecated", "parameters": [ { "name": "DiskIds", "type": "array", "required": true, "description": "将要卸载的云硬盘ID， 通过[DescribeDisks](/document/product/362/16315)接口查询，单次请求最多可卸载10块弹性云盘。", "example": "[\"disk-l7mxexxc\"]", "item_type": "string" }, { "name": "InstanceId", "type": "string", "required": false, "description": "对于非共享型云盘，会忽略该参数；对于共享型云盘，该参数表示要从哪个CVM实例上卸载云盘。", "example": "ins-arxix3xm" } ], "required": [ "DiskIds" ] }, { "name": "DetachNetworkInterface", "description": "弹性网卡解绑云主机", "status": "online", "parameters": [ { "name": "NetworkInterfaceId", "type": "string", "required": true, "description": "弹性网卡实例ID，例如：eni-m6dyj72l。", "example": "eni-ms7c7gcr" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。形如：ein-hcs7jkg4", "example": "ins-6zwa44xm" }, { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域，形如ap-xian-ecm。", "example": "ap-hangzhou-ecm" } ], "required": [ "NetworkInterfaceId", "InstanceId", "EcmRegion" ] }, { "name": "DisableRoutes", "description": "禁用已启用的子网路由", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表唯一ID。", "example": "rtb-12345678" }, { "name": "RouteIds", "type": "array", "required": true, "description": "路由策略ID。", "example": "[\"678\\n\"]", "item_type": "integer" } ], "required": [ "RouteTableId", "RouteIds" ] }, { "name": "DisassociateAddress", "description": "解绑弹性公网IP（简称 EIP） 只有状态为 BIND 和 BIND_ENI 的 EIP 才能进行解绑定操作。 EIP 如果被封堵，则不能进行解绑定操作。", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域", "example": "ap-hangzhou-ecm" }, { "name": "AddressId", "type": "string", "required": true, "description": "标识 EIP 的唯一 ID。EIP 唯一 ID 形如：eip-11112222。", "example": "eip-aihfuscm" }, { "name": "ReallocateNormalPublicIp", "type": "boolean", "required": false, "description": "表示解绑 EIP 之后是否分配普通公网 IP。取值范围： TRUE：表示解绑 EIP 之后分配普通公网 IP。 FALSE：表示解绑 EIP 之后不分配普通公网 IP。 默认取值：FALSE。 只有满足以下条件时才能指定该参数： 只有在解绑主网卡的主内网 IP 上的 EIP 时才能指定该参数。 解绑 EIP 后重新分配普通公网 IP 操作一个账号每天最多操作 10 次；详情可通过 DescribeAddressQuota 接口获取。", "example": "false" } ], "required": [ "EcmRegion", "AddressId" ] }, { "name": "DisassociateInstancesKeyPairs", "description": "用于解除实例的密钥绑定关系。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "可以通过以下方式获取可用的实例ID： 通过登录控制台查询实例ID。 通过调用接口 DescribeInstances ，取返回信息中的 InstanceId 获取实例ID。", "example": "[\"ein-8cnm1234\"]", "item_type": "string" }, { "name": "KeyIds", "type": "array", "required": true, "description": "密钥对ID列表，每次请求批量密钥对的上限为100。密钥对ID形如：skey-11112222。 可以通过以下方式获取可用的密钥ID： 通过登录控制台查询密钥ID。 通过调用接口 DescribeKeyPairs ，取返回信息中的 KeyId 获取密钥对ID。", "example": "[\"skey-dklg1234\"]", "item_type": "string" }, { "name": "ForceStop", "type": "boolean", "required": false, "description": "是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机，然后再解绑密钥。取值范围： TRUE：表示在正常关机失败后进行强制关机。 FALSE：表示在正常关机失败后不进行强制关机。 默认取值：FALSE。", "example": "false" } ], "required": [ "InstanceIds", "KeyIds" ] }, { "name": "DisassociateSecurityGroups", "description": "解绑安全组", "status": "online", "parameters": [ { "name": "SecurityGroupIds", "type": "array", "required": true, "description": "要解绑的安全组ID，类似esg-efil73jd，只支持解绑单个安全组。", "item_type": "string" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "被解绑的实例ID，类似ein-lesecurk，支持指定多个实例 。", "item_type": "string" } ], "required": [ "SecurityGroupIds", "InstanceIds" ] }, { "name": "EnableRoutes", "description": "启用已禁用的子网路由。 本接口会校验启用后，是否与已有路由冲突，如果冲突，则无法启用，失败处理。路由冲突时，需要先禁用与之冲突的路由，才能启用该路由。", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表唯一ID。", "example": "rtb-12345678" }, { "name": "RouteIds", "type": "array", "required": true, "description": "路由策略ID。", "example": "[\"678\\n\"]", "item_type": "integer" } ], "required": [ "RouteTableId", "RouteIds" ] }, { "name": "ImportCustomImage", "description": "导入自定义镜像，支持 RAW、VHD、QCOW2、VMDK 镜像格式", "status": "online", "parameters": [ { "name": "ImageName", "type": "string", "required": true, "description": "镜像名称" }, { "name": "Architecture", "type": "string", "required": true, "description": "导入镜像的操作系统架构，x86_64 或 i386" }, { "name": "OsType", "type": "string", "required": true, "description": "导入镜像的操作系统类型，通过DescribeImportImageOs获取" }, { "name": "OsVersion", "type": "string", "required": true, "description": "导入镜像的操作系统版本，通过DescribeImportImageOs获取" }, { "name": "ImageDescription", "type": "string", "required": false, "description": "镜像描述" }, { "name": "InitFlag", "type": "string", "required": false, "description": "镜像启动方式，cloudinit或nbd， 默认cloudinit" }, { "name": "ImageUrls", "type": "array", "required": false, "description": "镜像文件描述，多层镜像按顺序传入", "item_type": "object", "children": [ { "name": "ImageFile", "type": "string", "required": true, "description": "镜像文件COS链接，如设置私有读写，需授权腾讯云ECM运营账号访问权限。" } ] } ], "required": [ "ImageName", "Architecture", "OsType", "OsVersion" ] }, { "name": "ImportImage", "description": "从CVM产品导入镜像到ECM", "status": "online", "parameters": [ { "name": "ImageId", "type": "string", "required": true, "description": "镜像的Id。" }, { "name": "ImageDescription", "type": "string", "required": true, "description": "镜像的描述。" }, { "name": "SourceRegion", "type": "string", "required": true, "description": "源地域" } ], "required": [ "ImageId", "ImageDescription", "SourceRegion" ] }, { "name": "MigrateNetworkInterface", "description": "弹性网卡迁移", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域，形如ap-xian-ecm。", "example": "ap-hangzhou-ecm" }, { "name": "NetworkInterfaceId", "type": "string", "required": true, "description": "弹性网卡实例ID，例如：eni-m6dyj72l。", "example": "eni-4tw1bxlq" }, { "name": "SourceInstanceId", "type": "string", "required": true, "description": "弹性网卡当前绑定的ECM实例ID。形如：ein-r8hr2upy。", "example": "ins-ms7c7gcr" }, { "name": "DestinationInstanceId", "type": "string", "required": true, "description": "待迁移的目的ECM实例ID。", "example": "ins-6zwa44xm" } ], "required": [ "EcmRegion", "NetworkInterfaceId", "SourceInstanceId", "DestinationInstanceId" ] }, { "name": "MigratePrivateIpAddress", "description": "弹性网卡内网IP迁移。 该接口用于将一个内网IP从一个弹性网卡上迁移到另外一个弹性网卡，主IP地址不支持迁移。 迁移前后的弹性网卡必须在同一个子网内。", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域，形如ap-xian-ecm。", "example": "ap-hangzhou-ecm" }, { "name": "SourceNetworkInterfaceId", "type": "string", "required": true, "description": "当前内网IP绑定的弹性网卡实例ID，例如：eni-11112222。", "example": "eni-12121212" }, { "name": "DestinationNetworkInterfaceId", "type": "string", "required": true, "description": "待迁移的目的弹性网卡实例ID。", "example": "eni-13131313" }, { "name": "PrivateIpAddress", "type": "string", "required": true, "description": "迁移的内网IP地址，例如：10.0.0.6。", "example": "172.16.33.109" } ], "required": [ "EcmRegion", "SourceNetworkInterfaceId", "DestinationNetworkInterfaceId", "PrivateIpAddress" ] }, { "name": "ModifyAddressAttribute", "description": "修改弹性公网IP属性", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域", "example": "ap-chongqing-ecm2" }, { "name": "AddressId", "type": "string", "required": true, "description": "标识 EIP 的唯一 ID。EIP 唯一 ID 形如：eip-11112222。", "example": "eip-48d9e6ff" }, { "name": "AddressName", "type": "string", "required": false, "description": "修改后的 EIP 名称。长度上限为20个字符。", "example": "demo" }, { "name": "EipDirectConnection", "type": "string", "required": false, "description": "设定EIP是否直通，\"TRUE\"表示直通，\"FALSE\"表示非直通。注意该参数仅对EIP直通功能可见的用户可以设定。", "example": "false" } ], "required": [ "EcmRegion", "AddressId" ] }, { "name": "ModifyAddressesBandwidth", "description": "调整弹性公网IP带宽", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域", "example": "ap-chongqing-ecm2" }, { "name": "AddressIds", "type": "array", "required": true, "description": "EIP唯一标识ID，形如'eip-xxxxxxx'", "example": "[\"eip-85de31gh\"]", "item_type": "string" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": true, "description": "调整带宽目标值", "example": "10" } ], "required": [ "EcmRegion", "AddressIds", "InternetMaxBandwidthOut" ] }, { "name": "ModifyDefaultSubnet", "description": "修改在一个可用区下创建实例时使用的默认子网（创建实例时，未填写VPC参数时使用的sunbetId）", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM地域", "example": "ap-hangzhou-ecm" }, { "name": "Zone", "type": "string", "required": true, "description": "ECM可用区", "example": "ap-hangzhou-ecm-1" }, { "name": "VpcId", "type": "string", "required": true, "description": "私有网络ID", "example": "vpc-cp6wknwh" }, { "name": "SubnetId", "type": "string", "required": true, "description": "子网ID", "example": "subnet-jxa0xg1o" } ], "required": [ "EcmRegion", "Zone", "VpcId", "SubnetId" ] }, { "name": "ModifyHaVipAttribute", "description": "用于修改高可用虚拟IP（HAVIP）属性", "status": "online", "parameters": [ { "name": "HaVipId", "type": "string", "required": true, "description": "HAVIP唯一ID，形如：havip-9o233uri。", "example": "havip-9o233uri" }, { "name": "HaVipName", "type": "string", "required": true, "description": "HAVIP名称，可任意命名，但不得超过60个字符。", "example": "new+name" } ], "required": [ "HaVipId", "HaVipName" ] }, { "name": "ModifyImageAttribute", "description": "本接口（ModifyImageAttribute）用于修改镜像属性。", "status": "online", "parameters": [ { "name": "ImageId", "type": "string", "required": true, "description": "镜像ID，形如img-gvbnzy6f" }, { "name": "ImageName", "type": "string", "required": false, "description": "设置新的镜像名称；必须满足下列限制： 不得超过20个字符。 - 镜像名称不能与已有镜像重复。" }, { "name": "ImageDescription", "type": "string", "required": false, "description": "设置新的镜像描述；必须满足下列限制： - 不得超过60个字符。" } ], "required": [ "ImageId" ] }, { "name": "ModifyInstancesAttribute", "description": "修改实例的属性。", "status": "online", "parameters": [ { "name": "InstanceIdSet", "type": "array", "required": true, "description": "待修改的实例ID列表。在单次请求的过程中，请求实例数上限为100。", "item_type": "string" }, { "name": "InstanceName", "type": "string", "required": false, "description": "修改成功后显示的实例名称，不得超过60个字符，不传则名称显示为空。" }, { "name": "SecurityGroups", "type": "array", "required": false, "description": "指定实例的安全组Id列表，子机将重新关联指定列表的安全组，原本关联的安全组会被解绑。限制不超过5个。", "item_type": "string" } ], "required": [ "InstanceIdSet" ] }, { "name": "ModifyIpv6AddressesAttribute", "description": "本接口（ModifyIpv6AddressesAttribute）用于修改弹性网卡IPv6地址属性。", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域", "example": "ap-guangzhou-ecm-cu2" }, { "name": "NetworkInterfaceId", "type": "string", "required": true, "description": "弹性网卡实例ID，形如：eni-m6dyj72l。", "example": "eni-9c8zkfev" }, { "name": "Ipv6Addresses", "type": "array", "required": true, "description": "指定的IPv6地址信息。", "example": "[{\"Address\": \"3402:4e00:20:1202::7\", \"Description\": \"demo\"}]", "item_type": "object", "children": [ { "name": "Address", "type": "string", "required": true, "description": "IPv6地址，形如：3402:4e00:20:100:0:8cd9:2a67:71f3", "example": "3402:4e00:20:100:0:8cd9:2a67:71f3" }, { "name": "Primary", "type": "boolean", "required": false, "description": "是否是主IP。", "example": "true" }, { "name": "AddressId", "type": "string", "required": false, "description": "EIP实例ID，形如：eip-hxlqja90。", "example": "eip-hxlqja90" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息。", "example": "demo" }, { "name": "IsWanIpBlocked", "type": "boolean", "required": false, "description": "公网IP是否被封堵。", "example": "true" }, { "name": "State", "type": "string", "required": false, "description": "IPv6地址状态： PENDING：生产中 MIGRATING：迁移中 DELETING：删除中 AVAILABLE：可用的", "example": "AVAILABLE" } ] } ], "required": [ "EcmRegion", "NetworkInterfaceId", "Ipv6Addresses" ] }, { "name": "ModifyIpv6AddressesBandwidth", "description": "该接口(ModifyIpv6AddressesBandwidth)用于修改IPV6地址访问internet的带宽", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域", "example": "ap-guangzhou-ecm-cu2" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": true, "description": "修改的目标带宽，单位Mbps", "example": "50" }, { "name": "Ipv6Addresses", "type": "array", "required": false, "description": "IPV6地址。Ipv6Addresses和Ipv6AddressId必须且只能传一个", "example": "[\"2402:4e00:1000:200:0:8d8a:60b7:87f8\"]", "item_type": "object", "children": [ { "name": "Address", "type": "string", "required": true, "description": "IPv6地址，形如：3402:4e00:20:100:0:8cd9:2a67:71f3", "example": "3402:4e00:20:100:0:8cd9:2a67:71f3" }, { "name": "Primary", "type": "boolean", "required": false, "description": "是否是主IP。", "example": "true" }, { "name": "AddressId", "type": "string", "required": false, "description": "EIP实例ID，形如：eip-hxlqja90。", "example": "eip-hxlqja90" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息。", "example": "demo" }, { "name": "IsWanIpBlocked", "type": "boolean", "required": false, "description": "公网IP是否被封堵。", "example": "true" }, { "name": "State", "type": "string", "required": false, "description": "IPv6地址状态： PENDING：生产中 MIGRATING：迁移中 DELETING：删除中 AVAILABLE：可用的", "example": "AVAILABLE" } ] }, { "name": "Ipv6AddressIds", "type": "array", "required": false, "description": "IPV6地址对应的唯一ID，形如eip-xxxxxxxx。Ipv6Addresses和Ipv6AddressId必须且只能传一个", "example": "[\"eip-265fg963\"]", "item_type": "string" } ], "required": [ "EcmRegion", "InternetMaxBandwidthOut" ] }, { "name": "ModifyListener", "description": "修改负载均衡监听器属性。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID" }, { "name": "ListenerId", "type": "string", "required": true, "description": "负载均衡监听器 ID" }, { "name": "ListenerName", "type": "string", "required": false, "description": "新的监听器名称" }, { "name": "SessionExpireTime", "type": "integer", "required": false, "description": "会话保持时间，单位：秒。可选值：30~3600，默认 0，表示不开启。此参数仅适用于TCP/UDP监听器。" }, { "name": "HealthCheck", "type": "object", "required": false, "description": "健康检查相关参数", "children": [ { "name": "HealthSwitch", "type": "integer", "required": false, "description": "是否开启健康检查：1（开启）、0（关闭） 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "TimeOut", "type": "integer", "required": false, "description": "健康检查的响应超时时间，可选值：2~60，默认值：2，单位：秒。响应超时时间要小于检查间隔时间。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "IntervalTime", "type": "integer", "required": false, "description": "健康检查探测间隔时间，默认值：5，可选值：5~300，单位：秒。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "HealthNum", "type": "integer", "required": false, "description": "健康阈值，默认值：3，表示当连续探测三次健康则表示该转发正常，可选值：2~10，单位：次。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "UnHealthyNum", "type": "integer", "required": false, "description": "不健康阈值，默认值：3，表示当连续探测三次不健康则表示该转发异常，可选值：2~10，单位：次。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "CheckPort", "type": "integer", "required": false, "description": "自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "ContextType", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查的输入格式，可取值：HEX或TEXT；取值为HEX时，SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "SendContext", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查发送的请求内容，只允许ASCII可见字符，最大长度限制500。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "RecvContext", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查返回的结果，只允许ASCII可见字符，最大长度限制500。 注意：此字段可能返回 null，表示取不到有效值。" }, { "name": "CheckType", "type": "string", "required": false, "description": "自定义探测相关参数。健康检查使用的协议：TCP | CUSTOM（UDP监听器只支持CUSTOM；如果使用自定义健康检查功能，则必传）。 注意：此字段可能返回 null，表示取不到有效值。" } ] }, { "name": "Scheduler", "type": "string", "required": false, "description": "监听器转发的方式。可选值：WRR、LEAST_CONN 分别表示按权重轮询、最小连接数， 默认为 WRR。" } ], "required": [ "LoadBalancerId", "ListenerId" ] }, { "name": "ModifyLoadBalancerAttributes", "description": "修改负载均衡实例的属性。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡的唯一ID" }, { "name": "LoadBalancerName", "type": "string", "required": false, "description": "负载均衡实例名称" }, { "name": "InternetChargeInfo", "type": "object", "required": false, "description": "网络计费及带宽相关参数", "children": [ { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "最大出带宽，单位Mbps。默认值10", "example": "10" } ] }, { "name": "LoadBalancerPassToTarget", "type": "boolean", "required": false, "description": "Target是否放通来自ELB的流量。开启放通（true）：只验证ELB上的安全组；不开启放通（false）：需同时验证ELB和后端实例上的安全组。" } ], "required": [ "LoadBalancerId" ] }, { "name": "ModifyModuleConfig", "description": "修改模块配置，已关联实例的模块不支持调整配置。", "status": "online", "parameters": [ { "name": "ModuleId", "type": "string", "required": true, "description": "模块ID。", "example": "em-0vag13d1" }, { "name": "InstanceType", "type": "string", "required": true, "description": "机型ID。", "example": "SN3ne.2XLARGE16" }, { "name": "DefaultDataDiskSize", "type": "integer", "required": true, "description": "默认数据盘大小，单位：G。范围不得超过数据盘范围大小，详看DescribeConfig。", "example": "100" }, { "name": "DefaultSystemDiskSize", "type": "integer", "required": false, "description": "默认系统盘大小，单位：G。范围不得超过数据盘范围大小，详看DescribeConfig。", "example": "20" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "系统盘", "example": "无", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "硬盘类型。取值范围： - LOCAL_BASIC：本地硬盘； - CLOUD_PREMIUM：高性能云硬盘； 默认取值：CLOUD_BASIC。", "example": "CLOUD_PREMIUM" }, { "name": "DiskId", "type": "string", "required": false, "description": "硬盘ID。此参数暂不可用。", "example": "ldisk-1ly4f53h" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "硬盘容量大小。单位GB。", "example": "100" } ] }, { "name": "DataDisks", "type": "array", "required": false, "description": "数据盘", "example": "无", "item_type": "object", "children": [ { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘大小。单位GB。", "example": "100" }, { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型，取值范围： - LOCAL_BASIC：本地硬盘 - CLOUD_PREMIUM：高性能云硬盘 默认取值： LOCAL_BASIC。", "example": "CLOUD_PREMIUM" } ] } ], "required": [ "ModuleId", "InstanceType", "DefaultDataDiskSize" ] }, { "name": "ModifyModuleDisableWanIp", "description": "修改模块是否禁止分配外网ip的属性。", "status": "online", "parameters": [ { "name": "ModuleId", "type": "string", "required": true, "description": "模块ID" }, { "name": "DisableWanIp", "type": "boolean", "required": true, "description": "是否禁止分配外网ip,true：统一分配外网ip，false：禁止分配外网ip." } ], "required": [ "ModuleId", "DisableWanIp" ] }, { "name": "ModifyModuleImage", "description": "修改模块的默认镜像", "status": "online", "parameters": [ { "name": "DefaultImageId", "type": "string", "required": true, "description": "默认镜像ID", "example": "img-oy9q2bql" }, { "name": "ModuleId", "type": "string", "required": true, "description": "模块ID", "example": "em-bvr8f24q" } ], "required": [ "DefaultImageId", "ModuleId" ] }, { "name": "ModifyModuleIpDirect", "description": "修改模块IP直通。", "status": "online", "parameters": [ { "name": "ModuleId", "type": "string", "required": true, "description": "模块ID。" }, { "name": "CloseIpDirect", "type": "boolean", "required": true, "description": "是否关闭IP直通。取值范围： true：表示关闭IP直通 false：表示开通IP直通" } ], "required": [ "ModuleId", "CloseIpDirect" ] }, { "name": "ModifyModuleName", "description": "修改模块名称", "status": "online", "parameters": [ { "name": "ModuleId", "type": "string", "required": true, "description": "模块ID。" }, { "name": "ModuleName", "type": "string", "required": true, "description": "模块名称。" } ], "required": [ "ModuleId", "ModuleName" ] }, { "name": "ModifyModuleNetwork", "description": "修改模块默认带宽上限", "status": "online", "parameters": [ { "name": "ModuleId", "type": "string", "required": true, "description": "模块Id" }, { "name": "DefaultBandwidth", "type": "integer", "required": true, "description": "默认出带宽上限" }, { "name": "DefaultBandwidthIn", "type": "integer", "required": false, "description": "默认入带宽上限" } ], "required": [ "ModuleId", "DefaultBandwidth" ] }, { "name": "ModifyModuleSecurityGroups", "description": "修改模块默认安全组", "status": "online", "parameters": [ { "name": "SecurityGroupIdSet", "type": "array", "required": true, "description": "安全组列表。不超过5个。", "item_type": "string" }, { "name": "ModuleId", "type": "string", "required": true, "description": "模块id。" } ], "required": [ "SecurityGroupIdSet", "ModuleId" ] }, { "name": "ModifyPrivateIpAddressesAttribute", "description": "用于修改弹性网卡内网IP属性。", "status": "online", "parameters": [ { "name": "NetworkInterfaceId", "type": "string", "required": true, "description": "弹性网卡实例ID，例如：eni-m6dyj72l。", "example": "eni-afo43z61" }, { "name": "PrivateIpAddresses", "type": "array", "required": true, "description": "指定的内网IP信息。", "example": "[{\"PrivateIpAddress\":\"172.16.32.11\", \"Description\":\"TEST\"}]", "item_type": "object", "children": [ { "name": "PrivateIpAddress", "type": "string", "required": true, "description": "内网IP地址。", "example": "10.0.0.11" }, { "name": "Primary", "type": "boolean", "required": false, "description": "是否是主IP。", "example": "false" }, { "name": "PublicIpAddress", "type": "string", "required": false, "description": "公网IP地址。", "example": "123.11.100.87" }, { "name": "AddressId", "type": "string", "required": false, "description": "EIP实例ID，例如：eip-11112222。", "example": "eip-ms7c7gcr" }, { "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": "EcmRegion", "type": "string", "required": true, "description": "ECM 节点Region信息，形如ap-xian-ecm。", "example": "ap-qingdao-ecm" } ], "required": [ "NetworkInterfaceId", "PrivateIpAddresses", "EcmRegion" ] }, { "name": "ModifyRouteTableAttribute", "description": "修改路由表属性", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表实例ID，例如：rtb-azd4dt1c", "example": "rtb-n0yejvje" }, { "name": "RouteTableName", "type": "string", "required": true, "description": "路由表名称", "example": "NewRouteTableName" } ], "required": [ "RouteTableId", "RouteTableName" ] }, { "name": "ModifySecurityGroupAttribute", "description": "修改安全组属性", "status": "online", "parameters": [ { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组实例ID，例如esg-33ocnj9n，可通过DescribeSecurityGroups获取。", "example": "esg-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": "修改安全组出站和入站规则", "status": "online", "parameters": [ { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组实例ID，例如esg-33ocnj9n，可通过DescribeSecurityGroups获取。", "example": "esg-ohuuioma" }, { "name": "SecurityGroupPolicySet", "type": "object", "required": true, "description": "安全组规则集合。 SecurityGroupPolicySet对象必须同时指定新的出（Egress）入（Ingress）站规则。 SecurityGroupPolicy对象不支持自定义索引（PolicyIndex）。", "example": "{\"Version\":\"2\",\"Ingress\":[{\"PolicyIndex\":1,\"Protocol\":\"tcp\",\"Port\":\"80\",\"CidrBlock\":\"20.0.0.0/16\",\"Action\":\"ACCEPT\"}]}", "children": [ { "name": "Version", "type": "string", "required": false, "description": "安全组规则当前版本。用户每次更新安全规则版本会自动加1，防止更新的路由规则已过期，不填不考虑冲突。", "example": "2" }, { "name": "Egress", "type": "array", "required": false, "description": "出站规则。其中出站规则和入站规则必须选一个。", "example": "[{\"PolicyIndex\":1,\"Protocol\":\"tcp\",\"Port\":\"all\",\"CidrBlock\":\"0.0.0.0/0\",\"Action\":\"ACCEPT\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号", "example": "1" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。", "example": "80" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "{\"ServiceId\": \"eppm-f5n1f8da\", \"ServiceGroupId\": \"\"}", "children": [ { "name": "ServiceId", "type": "string", "required": true, "description": "协议端口ID，例如：eppm-f5n1f8da。", "example": "eppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": true, "description": "协议端口组ID，例如：eppmg-f5n1f8da。", "example": "eppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)。", "example": "0.0.0.0/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：esg-ohuuioma。", "example": "esg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者ID地址组ID。", "example": "{\"AddressId\": \"eipm-2uw6ujo6\", \"AddressGroupId\": \"\"}", "children": [ { "name": "AddressId", "type": "string", "required": true, "description": "IP地址ID，例如：eipm-2uw6ujo6。", "example": "eipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": true, "description": "IP地址组ID，例如：eipmg-2uw6ujo6。", "example": "eipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。", "example": "放通90端口" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间，例如 2020-07-22 19：27：23", "example": "2021-05-11 16:46:38" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。 注意：此字段可能返回 null，表示取不到有效值。", "example": "::/0" } ] }, { "name": "Ingress", "type": "array", "required": false, "description": "入站规则。其中出站规则和入站规则必须选一个。", "example": "[{\"PolicyIndex\":1,\"Protocol\":\"tcp\",\"Port\":\"80\",\"CidrBlock\":\"20.0.0.0/16\",\"Action\":\"ACCEPT\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号", "example": "1" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。", "example": "80" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "{\"ServiceId\": \"eppm-f5n1f8da\", \"ServiceGroupId\": \"\"}", "children": [ { "name": "ServiceId", "type": "string", "required": true, "description": "协议端口ID，例如：eppm-f5n1f8da。", "example": "eppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": true, "description": "协议端口组ID，例如：eppmg-f5n1f8da。", "example": "eppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)。", "example": "0.0.0.0/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：esg-ohuuioma。", "example": "esg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者ID地址组ID。", "example": "{\"AddressId\": \"eipm-2uw6ujo6\", \"AddressGroupId\": \"\"}", "children": [ { "name": "AddressId", "type": "string", "required": true, "description": "IP地址ID，例如：eipm-2uw6ujo6。", "example": "eipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": true, "description": "IP地址组ID，例如：eipmg-2uw6ujo6。", "example": "eipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。", "example": "放通90端口" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间，例如 2020-07-22 19：27：23", "example": "2021-05-11 16:46:38" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。 注意：此字段可能返回 null，表示取不到有效值。", "example": "::/0" } ] } ] }, { "name": "SortPolicys", "type": "boolean", "required": false, "description": "排序安全组标识。值为True时，支持安全组排序；SortPolicys不存在或SortPolicys为False时，为修改安全组规则。", "example": "false" } ], "required": [ "SecurityGroupId", "SecurityGroupPolicySet" ] }, { "name": "ModifySubnetAttribute", "description": "修改子网属性", "status": "online", "parameters": [ { "name": "SubnetId", "type": "string", "required": true, "description": "子网实例ID。形如：subnet-pxir56ns。", "example": "subnet-ae71tjp6" }, { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域", "example": "ap-hangzhou-ecm" }, { "name": "SubnetName", "type": "string", "required": false, "description": "子网名称，最大长度不能超过60个字节。", "example": "demo" }, { "name": "EnableBroadcast", "type": "string", "required": false, "description": "子网是否开启广播。", "example": "TRUE" }, { "name": "Tags", "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": true, "description": "标签值。", "example": "tag-val" } ] } ], "required": [ "SubnetId", "EcmRegion" ] }, { "name": "ModifyTargetPort", "description": "修改监听器绑定的后端机器的端口。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID" }, { "name": "ListenerId", "type": "string", "required": true, "description": "负载均衡监听器 ID" }, { "name": "Targets", "type": "array", "required": true, "description": "要修改端口的后端服务列表", "item_type": "object", "children": [ { "name": "Port", "type": "integer", "required": false, "description": "后端服务的监听端口" }, { "name": "InstanceId", "type": "string", "required": false, "description": "子机ID" }, { "name": "Weight", "type": "integer", "required": false, "description": "后端服务的转发权重，取值范围：[0, 100]，默认为 10。" }, { "name": "EniIp", "type": "string", "required": false, "description": "绑定弹性网卡时需要传入此参数，代表弹性网卡的IP，弹性网卡必须先绑定至子机，然后才能绑定到负载均衡实例。注意：参数 InstanceId 和 EniIp 只能传入一个且必须传入一个。" } ] }, { "name": "NewPort", "type": "integer", "required": true, "description": "后端服务绑定到监听器或转发规则的新端口" } ], "required": [ "LoadBalancerId", "ListenerId", "Targets", "NewPort" ] }, { "name": "ModifyTargetWeight", "description": "修改监听器绑定的后端机器的转发权重。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID" }, { "name": "ListenerId", "type": "string", "required": true, "description": "负载均衡监听器 ID" }, { "name": "Targets", "type": "array", "required": true, "description": "要修改权重的后端服务列表", "item_type": "object", "children": [ { "name": "Port", "type": "integer", "required": false, "description": "后端服务的监听端口" }, { "name": "InstanceId", "type": "string", "required": false, "description": "子机ID" }, { "name": "Weight", "type": "integer", "required": false, "description": "后端服务的转发权重，取值范围：[0, 100]，默认为 10。" }, { "name": "EniIp", "type": "string", "required": false, "description": "绑定弹性网卡时需要传入此参数，代表弹性网卡的IP，弹性网卡必须先绑定至子机，然后才能绑定到负载均衡实例。注意：参数 InstanceId 和 EniIp 只能传入一个且必须传入一个。" } ] }, { "name": "Weight", "type": "integer", "required": false, "description": "后端服务新的转发权重，取值范围：0~100，默认值10。如果设置了 Targets.Weight 参数，则此参数不生效。" } ], "required": [ "LoadBalancerId", "ListenerId", "Targets" ] }, { "name": "ModifyVpcAttribute", "description": "修改私有网络（VPC）的相关属性", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "VPC实例ID。形如：vpc-f49l6u0z。", "example": "vpc-m7sr81gh" }, { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域", "example": "ap-shenyang-ecm-cu" }, { "name": "VpcName", "type": "string", "required": false, "description": "私有网络名称，可任意命名，但不得超过60个字符。", "example": "TEST" }, { "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": true, "description": "标签值。", "example": "tag-val" } ] }, { "name": "Description", "type": "string", "required": false, "description": "私有网络描述", "example": "TEST" }, { "name": "DnsServers", "type": "array", "required": false, "description": "DNS地址，最多支持4个，第1个默认为主，其余为备。", "example": "['183.60.83.19']", "item_type": "string" }, { "name": "DomainName", "type": "string", "required": false, "description": "域名。", "example": "TEST" } ], "required": [ "VpcId", "EcmRegion" ] }, { "name": "QueryVpcTaskResult", "description": "查询私有网络下Vpc、子网、havip等异步任务请求结果", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "无", "example": "92126c28-17f4-4c93-b295-fed5d759f2f9" } ], "required": [ "TaskId" ] }, { "name": "RebootInstances", "description": "只有状态为RUNNING的实例才可以进行此操作；接口调用成功时，实例会进入REBOOTING状态；重启实例成功时，实例会进入RUNNING状态；支持强制重启，强制重启的效果等同于关闭物理计算机的电源开关再重新启动。强制重启可能会导致数据丢失或文件系统损坏，请仅在服务器不能正常重启时使用。", "status": "online", "parameters": [ { "name": "InstanceIdSet", "type": "array", "required": true, "description": "待重启的实例ID列表。在单次请求的过程中，单个region下的请求实例数上限为100。", "item_type": "string" }, { "name": "ForceReboot", "type": "boolean", "required": false, "description": "是否在正常重启失败后选择强制重启实例。取值范围： TRUE：表示在正常重启失败后进行强制重启； FALSE：表示在正常重启失败后不进行强制重启； 默认取值：FALSE。" }, { "name": "StopType", "type": "string", "required": false, "description": "关机类型。取值范围： SOFT：表示软关机 HARD：表示硬关机 SOFT_FIRST：表示优先软关机，失败再执行硬关机 默认取值：SOFT。" } ], "required": [ "InstanceIdSet" ] }, { "name": "ReleaseAddresses", "description": "释放一个或多个弹性公网IP（简称 EIP）。 该操作不可逆，释放后 EIP 关联的 IP 地址将不再属于您的名下。 只有状态为 UNBIND 的 EIP 才能进行释放操作。", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域", "example": "ap-chongqing-ecm2" }, { "name": "AddressIds", "type": "array", "required": true, "description": "标识 EIP 的唯一 ID 列表。", "example": "[\"eip-fg5896sc\"]", "item_type": "string" } ], "required": [ "EcmRegion", "AddressIds" ] }, { "name": "ReleaseIpv6Addresses", "description": "本接口（UnassignIpv6Addresses）用于释放弹性网卡IPv6地址。", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域", "example": "ap-xian-ecm " }, { "name": "NetworkInterfaceId", "type": "string", "required": true, "description": "弹性网卡实例ID，形如：eni-m6dyj72l。", "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:100:0:8cd9:2a67:71f3" }, { "name": "Primary", "type": "boolean", "required": false, "description": "是否是主IP。", "example": "true" }, { "name": "AddressId", "type": "string", "required": false, "description": "EIP实例ID，形如：eip-hxlqja90。", "example": "eip-hxlqja90" }, { "name": "Description", "type": "string", "required": false, "description": "描述信息。", "example": "demo" }, { "name": "IsWanIpBlocked", "type": "boolean", "required": false, "description": "公网IP是否被封堵。", "example": "true" }, { "name": "State", "type": "string", "required": false, "description": "IPv6地址状态： PENDING：生产中 MIGRATING：迁移中 DELETING：删除中 AVAILABLE：可用的", "example": "AVAILABLE" } ] } ], "required": [ "EcmRegion", "NetworkInterfaceId", "Ipv6Addresses" ] }, { "name": "ReleaseIpv6AddressesBandwidth", "description": "该接口用于给弹性公网IPv6地址释放带宽。", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域。", "example": "ap-xian-ecm" }, { "name": "Ipv6Addresses", "type": "array", "required": false, "description": "IPV6地址。Ipv6Addresses和Ipv6AddressIds必须且只能传一个。", "example": "[\"2402:4e00:1000:200:0:8d8a:60b7:87f8\"]", "item_type": "string" }, { "name": "Ipv6AddressIds", "type": "array", "required": false, "description": "IPV6地址对应的唯一ID，形如eip-xxxxxxxx。Ipv6Addresses和Ipv6AddressIds必须且只能传一个。", "example": "[\"eip-1534fc12\"]", "item_type": "string" } ], "required": [ "EcmRegion" ] }, { "name": "RemovePrivateIpAddresses", "description": "弹性网卡退还内网 IP。 退还弹性网卡上的辅助内网IP，接口自动解关联弹性公网 IP。不能退还弹性网卡的主内网IP。", "status": "online", "parameters": [ { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域，形如ap-xian-ecm。", "example": "ap-hangzhou-ecm" }, { "name": "NetworkInterfaceId", "type": "string", "required": true, "description": "弹性网卡实例ID，例如：eni-11112222。", "example": "eni-ms7c7gcr" }, { "name": "PrivateIpAddresses", "type": "array", "required": true, "description": "指定的内网IP信息，单次最多指定10个。", "example": "[{\"PrivateIpAddress\": \"172.16.32.111\"}]", "item_type": "object", "children": [ { "name": "PrivateIpAddress", "type": "string", "required": true, "description": "内网IP地址。", "example": "10.0.0.11" }, { "name": "Primary", "type": "boolean", "required": false, "description": "是否是主IP。", "example": "false" }, { "name": "PublicIpAddress", "type": "string", "required": false, "description": "公网IP地址。", "example": "123.11.100.87" }, { "name": "AddressId", "type": "string", "required": false, "description": "EIP实例ID，例如：eip-11112222。", "example": "eip-ms7c7gcr" }, { "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" } ] } ], "required": [ "EcmRegion", "NetworkInterfaceId", "PrivateIpAddresses" ] }, { "name": "ReplaceRouteTableAssociation", "description": "修改子网关联的路由表，一个子网只能关联一个路由表。", "status": "online", "parameters": [ { "name": "SubnetId", "type": "string", "required": true, "description": "子网实例ID，例如：subnet-3x5lf5q0。可通过DescribeSubnets接口查询。", "example": "subnet-q2079ils" }, { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表实例ID，例如：rtb-azd4dt1c。", "example": "rtb-n0yejvje" }, { "name": "EcmRegion", "type": "string", "required": true, "description": "ECM 地域", "example": "ap-hangzhou-ecm" } ], "required": [ "SubnetId", "RouteTableId", "EcmRegion" ] }, { "name": "ReplaceRoutes", "description": "替换路由策略", "status": "online", "parameters": [ { "name": "RouteTableId", "type": "string", "required": true, "description": "路由表实例ID。", "example": "rtb-n0yejvje" }, { "name": "Routes", "type": "array", "required": true, "description": "路由策略对象。", "example": "无", "item_type": "object", "children": [ { "name": "DestinationCidrBlock", "type": "string", "required": false, "description": "目的IPv4网段", "example": "10.2.2.0/24" }, { "name": "GatewayType", "type": "string", "required": false, "description": "下一跳类型 NORMAL_CVM：普通云服务器；", "example": "NAT" }, { "name": "GatewayId", "type": "string", "required": false, "description": "下一跳地址 这里只需要指定不同下一跳类型的网关ID，系统会自动匹配到下一跳地址 当 GatewayType 为 EIP 时，GatewayId 固定值 '0'", "example": "nat-irmuq4z4" }, { "name": "RouteItemId", "type": "string", "required": false, "description": "路由策略唯一ID", "example": "rti-mpgivlqt" }, { "name": "RouteDescription", "type": "string", "required": false, "description": "路由策略描述", "example": "TEST" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否启用", "example": "True" }, { "name": "RouteType", "type": "string", "required": false, "description": "路由类型，目前我们支持的类型有： USER：用户路由； NETD：网络探测路由，创建网络探测实例时，系统默认下发，不可编辑与删除； CCN：云联网路由，系统默认下发，不可编辑与删除。 用户只能添加和操作 USER 类型的路由。", "example": "CCN" }, { "name": "RouteId", "type": "integer", "required": false, "description": "路由策略ID。IPv4路由策略ID是有意义的值，IPv6路由策略是无意义的值0。后续建议完全使用字符串唯一ID `RouteItemId`操作路由策略", "example": "1" }, { "name": "RouteTableId", "type": "string", "required": false, "description": "路由表实例ID，例如：rtb-azd4dt1c。", "example": "rtb-azd4dt1c" } ] } ], "required": [ "RouteTableId", "Routes" ] }, { "name": "ReplaceSecurityGroupPolicy", "description": "替换单条安全组路由规则, 单个请求中只能替换单个方向的一条规则, 必须要指定索引（PolicyIndex）。", "status": "online", "parameters": [ { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组实例ID，例如esg-33ocnj9n，可通过DescribeSecurityGroups获取", "example": "esg-ohuuioma" }, { "name": "SecurityGroupPolicySet", "type": "object", "required": true, "description": "安全组规则集合对象。", "example": "{\"Version\":\"2\",\"Ingress\":[{\"PolicyIndex\":1,\"Protocol\":\"tcp\",\"Port\":\"80\",\"CidrBlock\":\"20.0.0.0/16\",\"Action\":\"ACCEPT\"}]}", "children": [ { "name": "Version", "type": "string", "required": false, "description": "安全组规则当前版本。用户每次更新安全规则版本会自动加1，防止更新的路由规则已过期，不填不考虑冲突。", "example": "2" }, { "name": "Egress", "type": "array", "required": false, "description": "出站规则。其中出站规则和入站规则必须选一个。", "example": "[{\"PolicyIndex\":1,\"Protocol\":\"tcp\",\"Port\":\"all\",\"CidrBlock\":\"0.0.0.0/0\",\"Action\":\"ACCEPT\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号", "example": "1" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。", "example": "80" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "{\"ServiceId\": \"eppm-f5n1f8da\", \"ServiceGroupId\": \"\"}", "children": [ { "name": "ServiceId", "type": "string", "required": true, "description": "协议端口ID，例如：eppm-f5n1f8da。", "example": "eppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": true, "description": "协议端口组ID，例如：eppmg-f5n1f8da。", "example": "eppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)。", "example": "0.0.0.0/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：esg-ohuuioma。", "example": "esg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者ID地址组ID。", "example": "{\"AddressId\": \"eipm-2uw6ujo6\", \"AddressGroupId\": \"\"}", "children": [ { "name": "AddressId", "type": "string", "required": true, "description": "IP地址ID，例如：eipm-2uw6ujo6。", "example": "eipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": true, "description": "IP地址组ID，例如：eipmg-2uw6ujo6。", "example": "eipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。", "example": "放通90端口" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间，例如 2020-07-22 19：27：23", "example": "2021-05-11 16:46:38" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。 注意：此字段可能返回 null，表示取不到有效值。", "example": "::/0" } ] }, { "name": "Ingress", "type": "array", "required": false, "description": "入站规则。其中出站规则和入站规则必须选一个。", "example": "[{\"PolicyIndex\":1,\"Protocol\":\"tcp\",\"Port\":\"80\",\"CidrBlock\":\"20.0.0.0/16\",\"Action\":\"ACCEPT\"}]", "item_type": "object", "children": [ { "name": "PolicyIndex", "type": "integer", "required": false, "description": "安全组规则索引号", "example": "1" }, { "name": "Protocol", "type": "string", "required": false, "description": "协议, 取值: TCP,UDP, ICMP。", "example": "TCP" }, { "name": "Port", "type": "string", "required": false, "description": "端口(all, 离散port, range)。", "example": "80" }, { "name": "ServiceTemplate", "type": "object", "required": false, "description": "协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。", "example": "{\"ServiceId\": \"eppm-f5n1f8da\", \"ServiceGroupId\": \"\"}", "children": [ { "name": "ServiceId", "type": "string", "required": true, "description": "协议端口ID，例如：eppm-f5n1f8da。", "example": "eppm-f5n1f8da" }, { "name": "ServiceGroupId", "type": "string", "required": true, "description": "协议端口组ID，例如：eppmg-f5n1f8da。", "example": "eppmg-f5n1f8da" } ] }, { "name": "CidrBlock", "type": "string", "required": false, "description": "网段或IP(互斥)。", "example": "0.0.0.0/0" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组实例ID，例如：esg-ohuuioma。", "example": "esg-ohuuioma" }, { "name": "AddressTemplate", "type": "object", "required": false, "description": "IP地址ID或者ID地址组ID。", "example": "{\"AddressId\": \"eipm-2uw6ujo6\", \"AddressGroupId\": \"\"}", "children": [ { "name": "AddressId", "type": "string", "required": true, "description": "IP地址ID，例如：eipm-2uw6ujo6。", "example": "eipm-2uw6ujo6" }, { "name": "AddressGroupId", "type": "string", "required": true, "description": "IP地址组ID，例如：eipmg-2uw6ujo6。", "example": "eipmg-2uw6ujo6" } ] }, { "name": "Action", "type": "string", "required": false, "description": "ACCEPT 或 DROP。", "example": "ACCEPT" }, { "name": "PolicyDescription", "type": "string", "required": false, "description": "安全组规则描述。", "example": "放通90端口" }, { "name": "ModifyTime", "type": "string", "required": false, "description": "修改时间，例如 2020-07-22 19：27：23", "example": "2021-05-11 16:46:38" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "网段或IPv6(互斥)。 注意：此字段可能返回 null，表示取不到有效值。", "example": "::/0" } ] } ] } ], "required": [ "SecurityGroupId", "SecurityGroupPolicySet" ] }, { "name": "ResetInstances", "description": "重装实例，若指定了ImageId参数，则使用指定的镜像重装；否则按照当前实例使用的镜像进行重装；若未指定密码，则密码通过站内信形式随后发送。", "status": "online", "parameters": [ { "name": "InstanceIdSet", "type": "array", "required": true, "description": "待重装的实例ID列表。", "example": "[\"ein-492054ga\\r\\n\",\"ein-482972ao\\r\\n\"]", "item_type": "string" }, { "name": "ImageId", "type": "string", "required": false, "description": "重装使用的镜像ID，若未指定，则使用各个实例当前的镜像进行重装。", "example": "img-q9fy0if9" }, { "name": "Password", "type": "string", "required": false, "description": "密码设置，若未指定，则后续将以站内信的形式通知密码。", "example": "hpjtfgnb3nwa" }, { "name": "EnhancedService", "type": "object", "required": false, "description": "是否开启腾讯云可观测平台和主机安全服务，未指定时默认开启。", "example": "无", "children": [ { "name": "SecurityService", "type": "object", "required": false, "description": "是否开启云镜服务。", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启。" }, { "name": "Version", "type": "integer", "required": false, "description": "云镜版本：0 基础版，1 专业版。目前仅支持基础版" } ] }, { "name": "MonitorService", "type": "object", "required": false, "description": "是否开启云监控服务。", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启。" } ] }, { "name": "EIPDirectService", "type": "object", "required": false, "description": "是否开通IP直通。若不指定该参数，则Linux镜像默认开通，windows镜像暂不支持IP直通。", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开通IP直通。取值范围： TRUE：表示开通IP直通 FALSE：表示不开通IP直通 默认取值：TRUE。 windows镜像目前不支持IP直通。" } ] } ] }, { "name": "KeepData", "type": "string", "required": false, "description": "是否保留数据盘数据，取值\"true\"/\"false\"。默认为\"true\"", "example": "true" }, { "name": "KeepImageLogin", "type": "string", "required": false, "description": "保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围： TRUE：表示保持镜像的登录设置 FALSE：表示不保持镜像的登录设置 默认取值：FALSE。 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" } ], "required": [ "InstanceIdSet" ] }, { "name": "ResetInstancesMaxBandwidth", "description": "重置实例的最大带宽上限。", "status": "online", "parameters": [ { "name": "InstanceIdSet", "type": "array", "required": true, "description": "待重置带宽上限的实例ID列表。在单次请求的过程中，单个region下的请求实例数上限为100。", "item_type": "string" }, { "name": "MaxBandwidthOut", "type": "integer", "required": true, "description": "修改后的最大出带宽上限。" }, { "name": "MaxBandwidthIn", "type": "integer", "required": false, "description": "修改后的最大入带宽上限。" } ], "required": [ "InstanceIdSet", "MaxBandwidthOut" ] }, { "name": "ResetInstancesPassword", "description": "重置处于运行中状态的实例的密码，需要显式指定强制关机参数ForceStop。如果没有显式指定强制关机参数，则只有处于关机状态的实例才允许执行重置密码操作。", "status": "online", "parameters": [ { "name": "InstanceIdSet", "type": "array", "required": true, "description": "待重置密码的实例ID列表。在单次请求的过程中，单个region下的请求实例数上限为100。", "item_type": "string" }, { "name": "Password", "type": "string", "required": true, "description": "新密码，Linux实例密码必须8到16位，至少包括两项[a-z，A-Z]、[0-9]和[( ) ~ ~ ! @ # $ % ^ \u0026 * - + = _ | { } [ ] : ; ' , . ? /]中的符号。密码不允许以/符号开头。 Windows实例密码必须12到16位，至少包括三项[a-z]，[A-Z]，[0-9]和[( ) ~ ~ ! @ # $ % ^ \u0026 * - + = _ | { } [ ] : ; ' , . ? /]中的符号。密码不允许以/符号开头。 如果实例即包含Linux实例又包含Windows实例，则密码复杂度限制按照Windows实例的限制。" }, { "name": "ForceStop", "type": "boolean", "required": false, "description": "是否强制关机，默认为false。" }, { "name": "UserName", "type": "string", "required": false, "description": "待重置密码的实例的用户名，不得超过64个字符。若未指定用户名，则对于Linux而言，默认重置root用户的密码，对于Windows而言，默认重置administrator的密码。" } ], "required": [ "InstanceIdSet", "Password" ] }, { "name": "ResetRoutes", "description": "对某个路由表名称和所有路由策略（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": "ResetRouteTableName" }, { "name": "Routes", "type": "array", "required": true, "description": "路由策略。", "example": "无", "item_type": "object", "children": [ { "name": "DestinationCidrBlock", "type": "string", "required": false, "description": "目的IPv4网段", "example": "10.2.2.0/24" }, { "name": "GatewayType", "type": "string", "required": false, "description": "下一跳类型 NORMAL_CVM：普通云服务器；", "example": "NAT" }, { "name": "GatewayId", "type": "string", "required": false, "description": "下一跳地址 这里只需要指定不同下一跳类型的网关ID，系统会自动匹配到下一跳地址 当 GatewayType 为 EIP 时，GatewayId 固定值 '0'", "example": "nat-irmuq4z4" }, { "name": "RouteItemId", "type": "string", "required": false, "description": "路由策略唯一ID", "example": "rti-mpgivlqt" }, { "name": "RouteDescription", "type": "string", "required": false, "description": "路由策略描述", "example": "TEST" }, { "name": "Enabled", "type": "boolean", "required": false, "description": "是否启用", "example": "True" }, { "name": "RouteType", "type": "string", "required": false, "description": "路由类型，目前我们支持的类型有： USER：用户路由； NETD：网络探测路由，创建网络探测实例时，系统默认下发，不可编辑与删除； CCN：云联网路由，系统默认下发，不可编辑与删除。 用户只能添加和操作 USER 类型的路由。", "example": "CCN" }, { "name": "RouteId", "type": "integer", "required": false, "description": "路由策略ID。IPv4路由策略ID是有意义的值，IPv6路由策略是无意义的值0。后续建议完全使用字符串唯一ID `RouteItemId`操作路由策略", "example": "1" }, { "name": "RouteTableId", "type": "string", "required": false, "description": "路由表实例ID，例如：rtb-azd4dt1c。", "example": "rtb-azd4dt1c" } ] } ], "required": [ "RouteTableId", "RouteTableName", "Routes" ] }, { "name": "RunInstances", "description": "创建ECM实例。", "status": "online", "parameters": [ { "name": "ZoneInstanceCountISPSet", "type": "array", "required": true, "description": "需要创建实例的可用区及创建数目及运营商的列表。在单次请求的过程中，单个region下的请求创建实例数上限为100", "example": "无", "item_type": "object", "children": [ { "name": "Zone", "type": "string", "required": true, "description": "创建实例的可用区。", "example": "ap-dongguan-ecm-1" }, { "name": "InstanceCount", "type": "integer", "required": true, "description": "在当前可用区创建的实例数目。", "example": "1" }, { "name": "ISP", "type": "string", "required": true, "description": "运营商如下： CTCC：中国电信 CUCC：中国联通 CMCC：中国移动 CMCC;CUCC;CTCC：三网；三网需要开通白名单，请直接联系腾讯云客服。", "example": "CMCC" }, { "name": "VpcId", "type": "string", "required": false, "description": "指定私有网络编号，SubnetId与VpcId必须同时指定或不指定", "example": "vpc-kcejgmxt" }, { "name": "SubnetId", "type": "string", "required": false, "description": "指定子网编号，SubnetId与VpcId必须同时指定或不指定", "example": "subnet-5r8jj7kg" }, { "name": "PrivateIpAddresses", "type": "array", "required": false, "description": "指定主网卡内网IP。条件：SubnetId与VpcId必须同时指定，并且IP数量与InstanceCount相同，多IP主机副网卡内网IP在相同子网内通过DHCP获取。", "example": "10.212.2.153", "item_type": "string" }, { "name": "Ipv6AddressCount", "type": "integer", "required": false, "description": "为弹性网卡指定随机生成的IPv6地址数量，单网情况下是1，单网需要ISP 只能为单网运营商，三网情况3", "example": "1" }, { "name": "Ipv6SubnetIds", "type": "array", "required": false, "description": "指定创建三网ipv6地址，使用的subnet数组，只创建ipv4不创建ipv6和单网ipv6子网依然使用SubnetId字段； 该数组必须且仅支持传入三个不同的子网，并且这三个子网各自分配了电信、联通、移动三个运营商的其中一个IPV6 CIDR网段", "example": "sub-123456", "item_type": "string" } ] }, { "name": "Password", "type": "string", "required": false, "description": "实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下： Linux实例密码必须8到30位，至少包括两项[a-z]，[A-Z]、[0-9] 和 [( ) ` ~ ! @ # $ % ^ \u0026 - + = | { } [ ] : ; ' , . ? / ]中的特殊符。Windows实例密码必须12到30位，至少包括三项[a-z]，[A-Z]，[0-9] 和 [( ) ` ~ ! @ # $ % ^ \u0026 - + = | { } [ ] : ; ' , . ? /]中的特殊符号。", "example": "pwd123" }, { "name": "InternetMaxBandwidthOut", "type": "integer", "required": false, "description": "公网出带宽上限，单位：Mbps。 1.如果未传该参数或者传的值为0，则使用模块下的默认值。 2.如果未传该参数或者传的值为0且未指定模块，则使用InternetMaxBandwidthIn的值", "example": "100" }, { "name": "ModuleId", "type": "string", "required": false, "description": "模块ID。如果未传该参数，则必须传ImageId，InstanceType，DataDiskSize，InternetMaxBandwidthOut参数", "example": "em-12345" }, { "name": "ImageId", "type": "string", "required": false, "description": "镜像ID。如果未传该参数或者传的值为空，则使用模块下的默认值", "example": "img-12345" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例显示名称。 不指定实例显示名称则默认显示‘未命名’。 购买多台实例，如果指定模式串{R:x}，表示生成数字[x, x+n-1]，其中n表示购买实例的数量，例如server\\_{R:3}，购买1台时，实例显示名称为server\\_3；购买2台时，实例显示名称分别为server\\_3，server\\_4。 支持指定多个模式串{R:x}。 购买多台实例，如果不指定模式串，则在实例显示名称添加后缀1、2...n，其中n表示购买实例的...", "example": "tsIns" }, { "name": "HostName", "type": "string", "required": false, "description": "主机名称 点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。 Windows 实例：名字符长度为[2, 15]，允许字母（不限制大小写）、数字和短横线（-）组成，不支持点号（.），不能全是数字。 其他类型（Linux 等）实例：字符长度为[2, 60]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。", "example": "test" }, { "name": "ClientToken", "type": "string", "required": false, "description": "用于保证请求幂等性的字符串。目前为保留参数，请勿使用。", "example": "qwerty**sfd" }, { "name": "EnhancedService", "type": "object", "required": false, "description": "增强服务。通过该参数可以指定是否开启云安全、腾讯云可观测平台等服务。若不指定该参数，则默认公共镜像开启腾讯云可观测平台、云安全服务", "example": "无", "children": [ { "name": "SecurityService", "type": "object", "required": false, "description": "是否开启云镜服务。", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启。" }, { "name": "Version", "type": "integer", "required": false, "description": "云镜版本：0 基础版，1 专业版。目前仅支持基础版" } ] }, { "name": "MonitorService", "type": "object", "required": false, "description": "是否开启云监控服务。", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开启。" } ] }, { "name": "EIPDirectService", "type": "object", "required": false, "description": "是否开通IP直通。若不指定该参数，则Linux镜像默认开通，windows镜像暂不支持IP直通。", "children": [ { "name": "Enabled", "type": "boolean", "required": false, "description": "是否开通IP直通。取值范围： TRUE：表示开通IP直通 FALSE：表示不开通IP直通 默认取值：TRUE。 windows镜像目前不支持IP直通。" } ] } ] }, { "name": "TagSpecification", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "ResourceType", "type": "string", "required": true, "description": "资源类型，目前仅支持\"instance\"、\"module\"" }, { "name": "Tags", "type": "array", "required": true, "description": "标签列表", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "标签健。", "example": "tag-key" }, { "name": "Value", "type": "string", "required": true, "description": "标签值。", "example": "tag-val" } ] } ] }, { "name": "UserData", "type": "string", "required": false, "description": "提供给实例使用的用户数据，需要以 base64 方式编码，支持的最大数据大小为 16KB", "example": "AA1234***==SG" }, { "name": "InstanceType", "type": "string", "required": false, "description": "机型。如果未传该参数或者传的值为空，则使用模块下的默认值", "example": "S4.2XLARGE16" }, { "name": "DataDiskSize", "type": "integer", "required": false, "description": "数据盘大小，单位是G。如果未传该参数或者传的值为0，则使用模块下的默认值", "example": "50" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数，则绑定默认安全组。", "example": "[ \"esg-g4k23455\" ]", "item_type": "string" }, { "name": "SystemDiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位是G。如果未传该参数或者传的值为0，则使用模块下的默认值", "example": "50" }, { "name": "InternetMaxBandwidthIn", "type": "integer", "required": false, "description": "公网入带宽上限，单位：Mbps。 1.如果未传该参数或者传的值为0，则使用对应模块的默认值。 2.如果未传该参数或者传的值为0且未指定模块，则使用InternetMaxBandwidthOut", "example": "100" }, { "name": "InstanceChargeType", "type": "integer", "required": false, "description": "实例计费类型。其中： 0，按资源维度后付费，计算当日用量峰值，例如CPU，内存，硬盘等，仅适用于非GNR系列机型； 1，按小时后付费，单价：xx元/实例/小时，仅适用于GNR机型，如需开通该计费方式请提工单申请； 2，按月后付费，单价：xx元/实例/月，仅适用于GNR机型； 该字段不填时，非GNR机型会默认选择0；GNR机型默认选择2。", "example": "0" }, { "name": "KeyIds", "type": "array", "required": false, "description": "密钥对。", "example": "[\"skey-dk12345\"]", "item_type": "string" }, { "name": "KeepImageLogin", "type": "string", "required": false, "description": "保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围： TRUE：表示保持镜像的登录设置 FALSE：表示不保持镜像的登录设置 默认取值：FALSE。 注意：此字段可能返回 null，表示取不到有效值。", "example": "TRUE" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "系统盘信息。", "example": "无", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "硬盘类型。取值范围： - LOCAL_BASIC：本地硬盘； - CLOUD_PREMIUM：高性能云硬盘； 默认取值：CLOUD_BASIC。", "example": "CLOUD_PREMIUM" }, { "name": "DiskId", "type": "string", "required": false, "description": "硬盘ID。此参数暂不可用。", "example": "ldisk-1ly4f53h" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "硬盘容量大小。单位GB。", "example": "100" } ] }, { "name": "DataDisks", "type": "array", "required": false, "description": "数据盘信息。", "example": "无", "item_type": "object", "children": [ { "name": "DiskSize", "type": "integer", "required": true, "description": "数据盘大小。单位GB。", "example": "100" }, { "name": "DiskType", "type": "string", "required": false, "description": "数据盘类型，取值范围： - LOCAL_BASIC：本地硬盘 - CLOUD_PREMIUM：高性能云硬盘 默认取值： LOCAL_BASIC。", "example": "CLOUD_PREMIUM" } ] } ], "required": [ "ZoneInstanceCountISPSet" ] }, { "name": "SetLoadBalancerSecurityGroups", "description": "设置负载均衡实例的安全组。", "status": "online", "parameters": [ { "name": "LoadBalancerId", "type": "string", "required": true, "description": "负载均衡实例 ID", "example": "lb-cuxw2rxx" }, { "name": "SecurityGroups", "type": "array", "required": false, "description": "安全组ID构成的数组，一个负载均衡实例最多可绑定5个安全组，如果要解绑所有安全组，可不传此参数，或传入空数组", "example": "sg-0936o7xx", "item_type": "string" } ], "required": [ "LoadBalancerId" ] }, { "name": "SetSecurityGroupForLoadbalancers", "description": "绑定或解绑一个安全组到多个负载均衡实例。", "status": "online", "parameters": [ { "name": "LoadBalancerIds", "type": "array", "required": true, "description": "负载均衡实例ID数组", "example": "lb-5b70qdxx", "item_type": "string" }, { "name": "SecurityGroup", "type": "string", "required": true, "description": "安全组ID，如 esg-12345678", "example": "sg-12345678" }, { "name": "OperationType", "type": "string", "required": true, "description": "ADD 绑定安全组； DEL 解绑安全组", "example": "ADD" } ], "required": [ "LoadBalancerIds", "SecurityGroup", "OperationType" ] }, { "name": "StartInstances", "description": "只有状态为STOPPED的实例才可以进行此操作；接口调用成功时，实例会进入STARTING状态；启动实例成功时，实例会进入RUNNING状态。", "status": "online", "parameters": [ { "name": "InstanceIdSet", "type": "array", "required": true, "description": "待开启的实例ID列表。在单次请求的过程中，单个region下的请求实例数上限为100。", "item_type": "string" } ], "required": [ "InstanceIdSet" ] }, { "name": "StopInstances", "description": "只有处于\"RUNNING\"状态的实例才能够进行关机操作； 调用成功时，实例会进入STOPPING状态；关闭实例成功时，实例会进入STOPPED状态； 支持强制关闭，强制关机的效果等同于关闭物理计算机的电源开关，强制关机可能会导致数据丢失或文件系统损坏，请仅在服务器不能正常关机时使用。", "status": "online", "parameters": [ { "name": "InstanceIdSet", "type": "array", "required": true, "description": "需要关机的实例ID列表。在单次请求的过程中，单个region下的请求实例数上限为100。", "item_type": "string" }, { "name": "ForceStop", "type": "boolean", "required": false, "description": "是否在正常关闭失败后选择强制关闭实例，默认为false，即否。" }, { "name": "StopType", "type": "string", "required": false, "description": "实例的关闭模式。取值范围： SOFT_FIRST：表示在正常关闭失败后进行强制关闭; HARD：直接强制关闭; SOFT：仅软关机； 默认为SOFT。" } ], "required": [ "InstanceIdSet" ] }, { "name": "TerminateDisks", "description": "CBS在ECM早已下线 本接口（TerminateDisks）用于退还云硬盘。 * 不再使用的云盘，可通过本接口主动退还。 * 本接口支持退还预付费云盘和按小时后付费云盘。按小时后付费云盘可直接退还，预付费云盘需符合退还规则。 * 支持批量操作，每次请求批量云硬盘的上限为50。如果批量云盘存在不允许操作的，请求会以特定错误码返回。", "status": "deprecated", "parameters": [ { "name": "DiskIds", "type": "array", "required": true, "description": "需退还的云盘ID列表。", "example": "[\"disk-l7mxexxc\"]", "item_type": "string" } ], "required": [ "DiskIds" ] }, { "name": "TerminateInstances", "description": "销毁实例", "status": "online", "parameters": [ { "name": "InstanceIdSet", "type": "array", "required": true, "description": "待销毁的实例ID列表。", "example": "[\"ein-ce71234\"]", "item_type": "string" }, { "name": "TerminateDelay", "type": "boolean", "required": false, "description": "是否定时销毁，默认为否。", "example": "false" }, { "name": "TerminateTime", "type": "string", "required": false, "description": "定时销毁的时间，格式形如：\"2019-08-05 12:01:30\"，若非定时销毁，则此参数被忽略。", "example": "2020-06-01 16:04:48" }, { "name": "AssociatedResourceDestroy", "type": "boolean", "required": false, "description": "是否关联删除已绑定的弹性网卡和弹性IP，默认为true。 当为true时，一并删除弹性网卡和弹性IP； 当为false时，只销毁主机，保留弹性网卡和弹性IP。", "example": "false" } ], "required": [ "InstanceIdSet" ] }, { "name": "UnassignIpv6SubnetCidrBlock", "description": "本接口（UnassignIpv6SubnetCidrBlock）用于释放IPv6子网段。 子网段如果还有IP占用且未回收，则子网段无法释放。", "status": "online", "parameters": [ { "name": "VpcId", "type": "string", "required": true, "description": "子网所在私有网络`ID`。形如：`vpc-f49l6u0z`。", "example": "vpc-q26u781x\t" }, { "name": "Ipv6SubnetCidrBlocks", "type": "array", "required": true, "description": "`IPv6` 子网段列表。", "example": "[{'SubnetId': 'subnet-8uwg949c'}]\t", "item_type": "object", "children": [ { "name": "SubnetId", "type": "string", "required": false, "description": "子网实例`ID`。形如：`subnet-pxir56ns`。 注意：此字段可能返回 null，表示取不到有效值。", "example": "subnet-pxir56ns" }, { "name": "Ipv6CidrBlock", "type": "string", "required": false, "description": "`IPv6`子网段。形如：`3402:4e00:20:1001::/64` 注意：此字段可能返回 null，表示取不到有效值。", "example": "3402:4e00:20:1001::/64" } ] }, { "name": "EcmRegion", "type": "string", "required": false, "description": "ECM地域。", "example": "ap-hefei-ecm" } ], "required": [ "VpcId", "Ipv6SubnetCidrBlocks" ] } ] }