Address
描述 EIP 信息
被如下接口引用:DescribeAddresses, DescribeRegionIpv6Addresses。
名称 | 类型 | 描述 |
---|---|---|
AddressId | String | EIP的ID,是EIP的唯一标识。 示例值:eip-3i05gfm7 |
AddressName | String | EIP名称。 示例值:EipName |
AddressStatus | String | EIP状态,包含'CREATING'(创建中),'BINDING'(绑定中),'BIND'(已绑定),'UNBINDING'(解绑中),'UNBIND'(已解绑),'OFFLINING'(释放中),'BIND_ENI'(绑定悬空弹性网卡) 示例值:BIND |
AddressIp | String | 外网IP地址 示例值:2402:4e00:1700:b500:0:9395:3e54:51e3 |
InstanceId | String | 绑定的资源实例ID。 注意:此字段可能返回 null,表示取不到有效值。 示例值:ein-37rhe9le |
CreatedTime | String | 创建时间。ISO 8601 格式:YYYY-MM-DDTHH:mm:ss.sssZ 示例值:2021-06-03T03:48:23Z |
NetworkInterfaceId | String | 绑定的弹性网卡ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:eni-37rhy9le |
PrivateAddressIp | String | 绑定的资源内网ip 注意:此字段可能返回 null,表示取不到有效值。 示例值:null |
IsArrears | Boolean | 资源隔离状态。true表示eip处于隔离状态,false表示资源处于未隔离状态 示例值:false |
IsBlocked | Boolean | 资源封堵状态。true表示eip处于封堵状态,false表示eip处于未封堵状态 示例值:false |
IsEipDirectConnection | Boolean | eip是否支持直通模式。true表示eip支持直通模式,false表示资源不支持直通模式 示例值:false |
AddressType | String | eip资源类型,包括"CalcIP","WanIP","EIP","AnycastEIP"。其中"CalcIP"表示设备ip,“WanIP”表示普通公网ip,“EIP”表示弹性公网ip,“AnycastEip”表示加速EIP 示例值:EIP |
CascadeRelease | Boolean | eip是否在解绑后自动释放。true表示eip将会在解绑后自动释放,false表示eip在解绑后不会自动释放 示例值:false |
InternetServiceProvider | String | 运营商,CTCC电信,CUCC联通,CMCC移动 注意:此字段可能返回 null,表示取不到有效值。 示例值:CTCC |
Bandwidth | Integer | 带宽上限 注意:此字段可能返回 null,表示取不到有效值。 示例值:1000 |
PayMode | String | 计费模式 注意:此字段可能返回 null,表示取不到有效值。 示例值:BANDWIDTH_PACKAGE |
AddressInfo
ip地址相关信息结构体。
被如下接口引用:DescribeInstances。
名称 | 类型 | 描述 |
---|---|---|
PublicIPAddressInfo | PublicIPAddressInfo | 实例的外网ip相关信息。 注意:此字段可能返回 null,表示取不到有效值。 |
PrivateIPAddressInfo | PrivateIPAddressInfo | 实例的内网ip相关信息。 注意:此字段可能返回 null,表示取不到有效值。 |
PublicIPv6AddressInfo | PublicIPAddressInfo | 实例的外网ipv6相关信息。 注意:此字段可能返回 null,表示取不到有效值。 |
AddressTemplateSpecification
IP地址模板
被如下接口引用:CreateSecurityGroupPolicies, DeleteSecurityGroupPolicies, DescribeSecurityGroupPolicies, ModifySecurityGroupPolicies, ReplaceSecurityGroupPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
AddressId | String | 是 | IP地址ID,例如:eipm-2uw6ujo6。 |
AddressGroupId | String | 是 | IP地址组ID,例如:eipmg-2uw6ujo6。 |
Area
区域信息
被如下接口引用:DescribeInstances, DescribeLoadBalancers, DescribeNode。
名称 | 类型 | 描述 |
---|---|---|
AreaId | String | 区域ID |
AreaName | String | 区域名称 |
AssistantCidr
VPC辅助CIDR信息。
被如下接口引用:CreateVpc, DescribeVpcs。
名称 | 类型 | 描述 |
---|---|---|
VpcId | String | VPC实例ID。形如:vpc-6v2ht8q5 |
CidrBlock | String | 辅助CIDR。形如:172.16.0.0/16 |
AssistantType | Integer | 辅助CIDR类型(0:普通辅助CIDR,1:容器辅助CIDR),默认都是0。 |
SubnetSet | Array of Subnet | 辅助CIDR拆分的子网。 注意:此字段可能返回 null,表示取不到有效值。 注意:此字段可能返回 null,表示取不到有效值。 |
Backend
负责均衡后端信息
被如下接口引用:DescribeTargets。
名称 | 类型 | 描述 |
---|---|---|
InstanceId | String | 后端服务的唯一 ID 注意:此字段可能返回 null,表示取不到有效值。 |
Port | Integer | 后端服务的监听端口 注意:此字段可能返回 null,表示取不到有效值。 |
Weight | Integer | 后端服务的转发权重,取值范围:[0, 100],默认为 10。 注意:此字段可能返回 null,表示取不到有效值。 |
PrivateIpAddresses | Array of String | 后端服务的内网 IP 注意:此字段可能返回 null,表示取不到有效值。 |
RegisteredTime | Timestamp | 后端服务被绑定的时间 注意:此字段可能返回 null,表示取不到有效值。 |
EniId | String | 弹性网卡唯一ID 注意:此字段可能返回 null,表示取不到有效值。 |
PublicIpAddresses | Array of String | 后端服务的外网 IP 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceName | String | 后端服务的实例名称 注意:此字段可能返回 null,表示取不到有效值。 |
BatchTarget
负责均衡批量目标项
被如下接口引用:BatchDeregisterTargets, BatchRegisterTargets。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ListenerId | String | 否 | 监听器ID |
Port | Integer | 否 | 绑定端口 |
InstanceId | String | 否 | 子机ID |
EniIp | String | 否 | 弹性网卡ip |
Weight | Integer | 否 | 子机权重,范围[0, 100]。绑定时如果不存在,则默认为10。 |
City
城市信息
被如下接口引用:DescribeInstances, DescribeLoadBalancers, DescribeNode。
名称 | 类型 | 描述 |
---|---|---|
CityId | String | 城市ID |
CityName | String | 城市名称 |
Country
国家信息
被如下接口引用:DescribeInstances, DescribeLoadBalancers, DescribeNode。
名称 | 类型 | 描述 |
---|---|---|
CountryId | String | 国家ID |
CountryName | String | 国家名称 |
DataDisk
描述了数据盘的信息
被如下接口引用:CreateModule, DescribeModuleDetail, DescribePriceRunInstance, ModifyModuleConfig, RunInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DiskSize | Integer | 是 | 数据盘大小。单位GB。 示例值:100 |
DiskType | String | 否 | 数据盘类型,取值范围: - LOCAL_BASIC:本地硬盘 - CLOUD_PREMIUM:高性能云硬盘 默认取值: LOCAL_BASIC。 示例值:CLOUD_PREMIUM |
Disk
描述了云硬盘的详细信息
被如下接口引用:DescribeDisks。
名称 | 类型 | 描述 |
---|---|---|
DeleteWithInstance | Boolean | 云盘是否与挂载的实例一起销毁。 注意:此字段可能返回 null,表示取不到有效值。 示例值:false |
RenewFlag | String | 自动续费标识。取值范围: 注意:此字段可能返回 null,表示取不到有效值。 示例值:NOTIFY_AND_AUTO_RENEW |
DiskType | String | 硬盘介质类型。取值范围: 示例值:CLOUD_SSD |
DiskState | String | 云盘状态。取值范围: 示例值:UNATTACHED |
SnapshotCount | Integer | 云盘拥有的快照总数。 示例值:0 |
AutoRenewFlagError | Boolean | 云盘已挂载到子机,且子机与云盘都是包年包月。 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
Rollbacking | Boolean | 云盘是否处于快照回滚状态。取值范围: 示例值:false |
InstanceIdList | Array of String | 对于非共享型云盘,该参数为空数组。对于共享型云盘,则表示该云盘当前被挂载到的CVM实例InstanceId 示例值:[] |
Encrypt | Boolean | 云盘是否为加密盘。取值范围: 示例值:false |
DiskName | String | 云硬盘名称。 示例值:unname |
BackupDisk | Boolean | 云硬盘因欠费销毁或者到期销毁时, 是否使用快照备份数据的标识。true表示销毁时创建快照进行数据备份。false表示直接销毁,不进行数据备份。 示例值:true |
Tags | Array of Tag | 与云盘绑定的标签,云盘未绑定标签则取值为空。 注意:此字段可能返回 null,表示取不到有效值。 示例值:"" |
InstanceId | String | 云硬盘挂载的云主机ID。 示例值:ins-xxxxxxx |
AutoSnapshotPolicyIds | Array of String | 云盘关联的定期快照ID。只有在调用DescribeDisks接口时,入参ReturnBindAutoSnapshotPolicy取值为TRUE才会返回该参数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:null |
ThroughputPerformance | Integer | 云硬盘额外性能值,单位MB/s。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
Migrating | Boolean | 云盘是否处于类型变更中。取值范围: 注意:此字段可能返回 null,表示取不到有效值。 示例值:false |
DiskId | String | 云硬盘ID。 示例值:disk-xxxxxxxx |
SnapshotSize | Integer | 云盘拥有的快照总容量,单位为MB。 示例值:0 |
Placement | Placement | 云硬盘所在的位置。 示例值:{"Zone":"ap-guangzhou-2","ProjectId":0} |
IsReturnable | Boolean | 判断预付费的云盘是否支持主动退还。 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
Attached | Boolean | 云盘是否挂载到云主机上。取值范围: 示例值:false |
DiskSize | Integer | 云硬盘大小,单位GB。 示例值:50 |
MigratePercent | Integer | 云盘类型变更的迁移进度,取值0到100。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
DiskUsage | String | 云硬盘类型。取值范围: 示例值:SYSTEM_DISK |
DiskChargeType | String | 付费模式。取值范围: 示例值:PREPAID |
Portable | Boolean | 是否为弹性云盘,false表示非弹性云盘,true表示弹性云盘。 示例值:true |
SnapshotAbility | Boolean | 云盘是否具备创建快照的能力。取值范围: 示例值:true |
DeadlineError | Boolean | 在云盘已挂载到实例,且实例与云盘都是包年包月的条件下,此字段才有意义。 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
RollbackPercent | Integer | 云盘快照回滚的进度。 示例值:0 |
DifferDaysOfDeadline | Integer | 当前时间距离盘到期的天数(仅对预付费盘有意义)。 注意:此字段可能返回 null,表示取不到有效值。 示例值:20 |
ReturnFailCode | Integer | 预付费云盘在不支持主动退还的情况下,该参数表明不支持主动退还的具体原因。取值范围: 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
Shareable | Boolean | 云盘是否为共享型云盘。 示例值:false |
CreateTime | Timestamp | 云硬盘的创建时间。 示例值:2021-01-01 12:00:00 |
DeadlineTime | Timestamp | 云硬盘的到期时间。 示例值:2021-02-01 12:00:00 |
AttachMode | String | 云盘的挂载类型。取值范围: 注意:此字段可能返回 null,表示取不到有效值。 示例值:PF |
DiskChargePrepaid
描述了实例的计费模式
被如下接口引用:CreateDisks。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Period | Integer | 是 | 购买云盘的时长,默认单位为月,取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。 示例值:1 |
RenewFlag | String | 否 | 自动续费标识。取值范围: 默认取值:NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费。 示例值:NOTIFY_AND_AUTO_RENEW |
CurInstanceDeadline | Timestamp | 否 | 需要将云盘的到期时间与挂载的子机对齐时,可传入该参数。该参数表示子机当前的到期时间,此时Period如果传入,则表示子机需要续费的时长,云盘会自动按对齐到子机续费后的到期时间续费,示例取值:2018-03-30 20:15:03。 示例值:2018-03-30 20:15:03 |
DiskInfo
磁盘信息
被如下接口引用:DescribeInstances。
名称 | 类型 | 描述 |
---|---|---|
DiskType | String | 磁盘类型:LOCAL_BASIC |
DiskId | String | 磁盘ID |
DiskSize | Integer | 磁盘大小(GB) |
DeleteWithInstance | Boolean | 是否随实例删除。 |
SnapshotId | String | 快照ID 注意:此字段可能返回 null,表示取不到有效值。 |
EipQuota
描述EIP配额信息
被如下接口引用:DescribeAddressQuota。
名称 | 类型 | 描述 |
---|---|---|
QuotaId | String | 配额名称,取值范围: TOTAL_EIP_QUOTA:用户当前地域下EIP的配额数; DAILY_EIP_APPLY:用户当前地域下今日申购次数; DAILY_PUBLIC_IP_ASSIGN:用户当前地域下,重新分配公网 IP次数。 |
QuotaCurrent | Integer | 当前数量 |
QuotaLimit | Integer | 配额数量 |
EnhancedService
增强服务
被如下接口引用:ResetInstances, RunInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
SecurityService | RunSecurityServiceEnabled | 否 | 是否开启云镜服务。 |
MonitorService | RunMonitorServiceEnabled | 否 | 是否开启云监控服务。 |
EIPDirectService | RunEIPDirectServiceEnabled | 否 | 是否开通IP直通。若不指定该参数,则Linux镜像默认开通,windows镜像暂不支持IP直通。 |
Filter
描述键值对过滤器,用于条件过滤查询。
被如下接口引用:DescribeAddresses, DescribeCustomImageTask, DescribeDisks, DescribeHaVips, DescribeImage, DescribeInstances, DescribeLoadBalancers, DescribeModule, DescribeMonthPeakNetwork, DescribeNetworkInterfaces, DescribeNode, DescribePackingQuotaGroup, DescribePeakNetworkOverview, DescribeRegionIpv6Addresses, DescribeRouteTables, DescribeSecurityGroups, DescribeSnapshots, DescribeSubnets, DescribeVpcs。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Values | Array of String | 是 | 一个或者多个过滤值。 示例值:["V0", "V1"] |
Name | String | 是 | 过滤键的名称。 示例值:"FilterName" |
HaVip
HAVIP对象。
被如下接口引用:CreateHaVip, DescribeHaVips。
名称 | 类型 | 描述 |
---|---|---|
HaVipId | String | HAVIP的ID,是HAVIP的唯一标识。 |
HaVipName | String | HAVIP名称。 |
Vip | String | 虚拟IP地址。 |
VpcId | String | HAVIP所在私有网络ID。 |
SubnetId | String | HAVIP所在子网ID。 |
NetworkInterfaceId | String | HAVIP关联弹性网卡ID。 |
InstanceId | String | 被绑定的实例ID。 |
AddressIp | String | 绑定EIP。 |
State | String | 状态: AVAILABLE:运行中。 UNBIND:未绑定。 |
CreatedTime | String | 创建时间。 |
Business | String | 使用havip的业务标识。 |
HealthCheck
负载均衡健康检查
被如下接口引用:CreateListener, DescribeListeners, ModifyListener。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
HealthSwitch | Integer | 否 | 是否开启健康检查:1(开启)、0(关闭) 注意:此字段可能返回 null,表示取不到有效值。 |
TimeOut | Integer | 否 | 健康检查的响应超时时间,可选值:2~60,默认值:2,单位:秒。响应超时时间要小于检查间隔时间。 注意:此字段可能返回 null,表示取不到有效值。 |
IntervalTime | Integer | 否 | 健康检查探测间隔时间,默认值:5,可选值:5~300,单位:秒。 注意:此字段可能返回 null,表示取不到有效值。 |
HealthNum | Integer | 否 | 健康阈值,默认值:3,表示当连续探测三次健康则表示该转发正常,可选值:2~10,单位:次。 注意:此字段可能返回 null,表示取不到有效值。 |
UnHealthyNum | Integer | 否 | 不健康阈值,默认值:3,表示当连续探测三次不健康则表示该转发异常,可选值:2~10,单位:次。 注意:此字段可能返回 null,表示取不到有效值。 |
CheckPort | Integer | 否 | 自定义探测相关参数。健康检查端口,默认为后端服务的端口,除非您希望指定特定端口,否则建议留空。 注意:此字段可能返回 null,表示取不到有效值。 |
ContextType | String | 否 | 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时,必填此字段,代表健康检查的输入格式,可取值:HEX或TEXT;取值为HEX时,SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。 注意:此字段可能返回 null,表示取不到有效值。 |
SendContext | String | 否 | 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时,必填此字段,代表健康检查发送的请求内容,只允许ASCII可见字符,最大长度限制500。 注意:此字段可能返回 null,表示取不到有效值。 |
RecvContext | String | 否 | 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时,必填此字段,代表健康检查返回的结果,只允许ASCII可见字符,最大长度限制500。 注意:此字段可能返回 null,表示取不到有效值。 |
CheckType | String | 否 | 自定义探测相关参数。健康检查使用的协议:TCP | CUSTOM(UDP监听器只支持CUSTOM;如果使用自定义健康检查功能,则必传)。 注意:此字段可能返回 null,表示取不到有效值。 |
ISP
运营商信息
被如下接口引用:DescribeInstances, DescribeNode。
名称 | 类型 | 描述 |
---|---|---|
ISPId | String | 运营商ID |
ISPName | String | 运营商名称 |
ISPCounter
运行商统计信息
被如下接口引用:DescribeModuleDetail。
名称 | 类型 | 描述 |
---|---|---|
ProviderName | String | 运营商名称 示例值:CTCC |
ProviderNodeNum | Integer | 节点数量 示例值:1 |
ZoneInstanceInfoSet | Array of ZoneInstanceInfo | Zone实例信息结构体数组 示例值:[ { "ZoneName": "北京三区(电信)", "InstanceNum": 1 } ] |
ProviderInstanceNum | Integer | 实例数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ISPIPv6CidrBlock
多运营商IPv6 Cidr Block
被如下接口引用:AssignIpv6CidrBlocks, CreateVpc, DescribeVpcs。
名称 | 类型 | 描述 |
---|---|---|
IPv6CidrBlock | String | IPv6 CIdr Block。 注意:此字段可能返回 null,表示取不到有效值。 示例值:"2402:4e00:1717:8200::/56", |
ISPType | String | 网络运营商类型 取值范围:'CMCC'-中国移动, 'CTCC'-中国电信, 'CUCC'-中国联调 注意:此字段可能返回 null,表示取不到有效值。 示例值:CMCC |
ISPTypeItem
申请ipv6 cidr block的信息
被如下接口引用:AssignIpv6CidrBlocks, CreateVpc。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ISPType | String | 否 | IPv6 Cidr所属运营商类型,支持的类型有 'CMCC'-中国移动, 'CTCC'-中国电信, 'CUCC'-中国联调。作为入参数时为必选。 示例值:CMCC |
Count | Integer | 否 | 申请IPv6 Cidr Block的个数。作为入参数时为必选。 示例值:1 |
Image
镜像信息
被如下接口引用:DescribeImage, DescribeInstances, DescribeModuleDetail, DescribeSnapshots。
名称 | 类型 | 描述 |
---|---|---|
ImageId | String | 镜像ID 示例值:img-gfoqboh1 |
ImageName | String | 镜像名称 示例值:测试镜像 |
ImageState | String | 镜像状态 示例值:NORMAL |
ImageType | String | 镜像类型 示例值:PRIVATE_IMAGE |
ImageOsName | String | 操作系统名称 示例值:CentOS 7.6.0 64位 |
ImageDescription | String | 镜像描述 示例值:测试用 |
ImageCreateTime | String | 镜像导入时间 示例值:2024-02-06 12:32:47 |
Architecture | String | 操作系统位数 示例值:x86_64 |
OsType | String | 操作系统类型 示例值:linux |
OsVersion | String | 操作系统版本 示例值:16.0 |
Platform | String | 操作系统平台 示例值:Ubuntu |
ImageOwner | Integer | 镜像所有者 示例值:12345678 |
ImageSize | Integer | 镜像大小。单位:GB 示例值:50 |
SrcImage | SrcImage | 镜像来源信息 |
ImageSource | String | 镜像来源类型 示例值:EXTERNAL_IMPORT |
TaskId | String | 中间态和失败时候的任务ID 示例值:1234 |
IsSupportCloudInit | Boolean | 是否支持CloudInit 示例值:true |
ImageLimitConfig
镜像限制配置
被如下接口引用:DescribeConfig。
名称 | 类型 | 描述 |
---|---|---|
MaxImageSize | Integer | 支持的最大镜像大小,包括可导入的自定义镜像大小,中心云镜像大小,单位为GB。 示例值:50 |
ImageOsList
支持的操作系统类型,根据windows和Linux分类。
被如下接口引用:DescribeImportImageOs。
名称 | 类型 | 描述 |
---|---|---|
Windows | Array of String | 支持的windows操作系统 注意:此字段可能返回 null,表示取不到有效值。 |
Linux | Array of String | 支持的linux操作系统 注意:此字段可能返回 null,表示取不到有效值。 |
ImageTask
镜像任务
被如下接口引用:DescribeCustomImageTask。
名称 | 类型 | 描述 |
---|---|---|
State | String | 镜像导入状态, PENDING, PROCESSING, SUCCESS, FAILED |
Message | String | 导入失败(FAILED)时, 说明失败原因 注意:此字段可能返回 null,表示取不到有效值。 |
ImageName | String | 镜像名称 |
CreateTime | String | 创建时间 |
ImageUrl
镜像文件信息
被如下接口引用:ImportCustomImage。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ImageFile | String | 是 | 镜像文件COS链接,如设置私有读写,需授权腾讯云ECM运营账号访问权限。 |
Instance
用于描述实例相关的信息。
被如下接口引用:DescribeInstances。
名称 | 类型 | 描述 |
---|---|---|
InstanceId | String | 实例ID。 示例值:ein-5afzpqpk |
InstanceName | String | 实例名称,如ens-34241f3s。 注意:此字段可能返回 null,表示取不到有效值。 示例值:proxyIns0410009 |
InstanceState | String | 实例状态。取值范围: PENDING:表示创建中 LAUNCH_FAILED:表示创建失败 RUNNING:表示运行中 STOPPED:表示关机 STARTING:表示开机中 STOPPING:表示关机中 REBOOTING:表示重启中 SHUTDOWN:表示停止待销毁 TERMINATING:表示销毁中。 示例值:TERMINATED |
Image | Image | 实例当前使用的镜像的信息。 注意:此字段可能返回 null,表示取不到有效值。 |
SimpleModule | SimpleModule | 实例当前所属的模块简要信息。 注意:此字段可能返回 null,表示取不到有效值。 |
Position | Position | 实例所在的位置相关信息。 注意:此字段可能返回 null,表示取不到有效值。 |
Internet | Internet | 实例的网络相关信息。 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceTypeConfig | InstanceTypeConfig | 实例的配置相关信息。 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 实例的创建时间。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2024-02-18 16:59:51 |
TagSet | Array of Tag | 实例的标签信息。 注意:此字段可能返回 null,表示取不到有效值。 |
LatestOperation | String | 实例最后一次操作。 注意:此字段可能返回 null,表示取不到有效值。 示例值:TerminateInstances |
LatestOperationState | String | 实例最后一次操作结果。 注意:此字段可能返回 null,表示取不到有效值。 示例值:OPERATING |
RestrictState | String | 实例业务状态。取值范围: NORMAL:表示正常状态的实例 EXPIRED:表示过期的实例 PROTECTIVELY_ISOLATED:表示被安全隔离的实例。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NORMAL |
SystemDiskSize | Integer | 系统盘大小,单位GB。 注意:此字段可能返回 null,表示取不到有效值。 示例值:50 |
DataDiskSize | Integer | 数据盘大小,单位GB。 注意:此字段可能返回 null,表示取不到有效值。 示例值:500 |
UUID | String | 实例UUID 注意:此字段可能返回 null,表示取不到有效值。 示例值:3d4b86db-6380-4fe4-8f0b-c9e78fa92ba0 |
PayMode | Integer | 付费方式。 0为后付费。 1为预付费。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
ExpireTime | String | 过期时间。格式为yyyy-mm-dd HH:mm:ss。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2024-02-18 16:59:51 |
IsolatedTime | String | 隔离时间。格式为yyyy-mm-dd HH:mm:ss。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2024-02-18 16:59:51 |
RenewFlag | Integer | 是否自动续费。 0为不自动续费。 1为自动续费。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
ExpireState | String | 过期状态。 NORMAL 表示机器运行正常。 WILL_EXPIRE 表示即将过期。 EXPIRED 表示已过期。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NORMAL |
SystemDisk | DiskInfo | 系统盘信息 注意:此字段可能返回 null,表示取不到有效值。 |
DataDisks | Array of DiskInfo | 数据盘信息 注意:此字段可能返回 null,表示取不到有效值。 |
NewFlag | Integer | 新实例标志 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
SecurityGroupIds | Array of String | 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。 注意:此字段可能返回 null,表示取不到有效值。 示例值:esg-g4k9lznc |
VirtualPrivateCloud | VirtualPrivateCloud | VPC属性 注意:此字段可能返回 null,表示取不到有效值。 |
ISP | String | 实例运营商字段。 注意:此字段可能返回 null,表示取不到有效值。 示例值:CTCC |
PhysicalPosition | PhysicalPosition | 物理位置信息。注意该字段目前为保留字段,均为空值。 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceFamilyConfig
机型族配置
被如下接口引用:DescribeInstanceTypeConfig, DescribeInstances, DescribeModuleDetail。
名称 | 类型 | 描述 |
---|---|---|
InstanceFamilyName | String | 机型名称 |
InstanceFamily | String | 机型ID |
InstanceFamilyTypeConfig
实例系列类型配置
被如下接口引用:DescribeInstanceTypeConfig, DescribeInstances, DescribeModuleDetail, DescribePeakBaseOverview。
名称 | 类型 | 描述 |
---|---|---|
InstanceFamilyType | String | 实例机型系列类型Id |
InstanceFamilyTypeName | String | 实例机型系列类型名称 |
InstanceNetworkInfo
实例网卡ip网络信息数组
被如下接口引用:DescribeInstances。
名称 | 类型 | 描述 |
---|---|---|
AddressInfoSet | Array of AddressInfo | 实例内外网ip相关信息。 注意:此字段可能返回 null,表示取不到有效值。 |
NetworkInterfaceId | String | 网卡ID。 |
NetworkInterfaceName | String | 网卡名称。 注意:此字段可能返回 null,表示取不到有效值。 |
Primary | Boolean | 主网卡属性。true为主网卡,false为辅助网卡。 |
InstanceNetworkLimitConfig
机器网络资源限制
被如下接口引用:DescribeConfig。
名称 | 类型 | 描述 |
---|---|---|
CpuNum | Integer | cpu核数 |
NetworkInterfaceLimit | Integer | 网卡数量限制 |
InnerIpPerNetworkInterface | Integer | 每张网卡内网ip数量限制 |
PublicIpPerInstance | Integer | 每个实例的外网ip限制 |
InstanceOperator
实例可执行操作
被如下接口引用:DescribeInstancesDeniedActions。
名称 | 类型 | 描述 |
---|---|---|
InstanceId | String | 实例id |
DeniedActions | Array of OperatorAction | 实例禁止的操作 注意:此字段可能返回 null,表示取不到有效值。 |
InstancePricesPartDetail
描述实例的价格相关
被如下接口引用:DescribePriceRunInstance。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
CpuPrice | PriceDetail | 是 | cpu的价格信息 |
MemPrice | PriceDetail | 是 | 内存价格信息 |
DisksPrice | PriceDetail | 是 | 磁盘价格信息 |
InstanceStatistic
用于描述实例的统计信息
被如下接口引用:DescribeSecurityGroupAssociationStatistics。
名称 | 类型 | 描述 |
---|---|---|
InstanceType | String | 实例的类型 |
InstanceCount | Integer | 实例的个数 |
InstanceTypeConfig
机型配置
被如下接口引用:DescribeInstanceTypeConfig, DescribeInstances, DescribeModuleDetail。
名称 | 类型 | 描述 |
---|---|---|
InstanceFamilyConfig | InstanceFamilyConfig | 机型族配置信息 |
InstanceType | String | 机型 示例值:VIS.16XLARGE128 |
Vcpu | Integer | CPU核数 示例值:2 |
Memory | Integer | 内存大小 示例值:4 |
Frequency | String | 主频 示例值:2.5 GHz |
CpuModelName | String | 处理器型号 示例值:Intel Xeon Skylake 6133 |
InstanceFamilyTypeConfig | InstanceFamilyTypeConfig | 机型族类别配置信息 |
ExtInfo | String | 机型额外信息 是一个json字符串,如果存在则表示特殊机型,格式如下:{"dataDiskSize":3200,"systemDiskSize":60, "systemDiskSizeShow":"系统盘默认60G","dataDiskSizeShow":"本地NVMe SSD 硬盘3200 GB"} 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"dataDiskSize":3200,"systemDiskSize":60, "systemDiskSizeShow":"系统盘默认60G","dataDiskSizeShow":"本地NVMe SSD 硬盘3200 GB"} |
Vgpu | Float | GPU卡数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
GpuModelName | String | GPU型号 注意:此字段可能返回 null,表示取不到有效值。 示例值:NVDIA Tesla T4 |
InstancesPrice
实例价格信息
被如下接口引用:DescribePriceRunInstance。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
InstancePricesPartDetail | InstancePricesPartDetail | 是 | 分部描述实例子维度的价格 |
Discount | Integer | 是 | 实例总价折扣 示例值:20 |
DiscountPrice | Integer | 是 | 折扣后价格 示例值:200 |
OriginalPrice | Integer | 是 | 折扣前价格,原始总价 示例值:1000 |
Internet
实例的网络相关信息。
被如下接口引用:DescribeInstances。
名称 | 类型 | 描述 |
---|---|---|
PrivateIPAddressSet | Array of PrivateIPAddressInfo | 实例的内网相关信息列表。顺序为主网卡在前,辅助网卡按绑定先后顺序排列。 注意:此字段可能返回 null,表示取不到有效值。 |
PublicIPAddressSet | Array of PublicIPAddressInfo | 实例的公网相关信息列表。顺序为主网卡在前,辅助网卡按绑定先后顺序排列。 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceNetworkInfoSet | Array of InstanceNetworkInfo | 实例网络相关信息。 注意:此字段可能返回 null,表示取不到有效值。 |
Ipv6Address
IPv6地址信息。
被如下接口引用:AssignIpv6Addresses, CreateNetworkInterface, DescribeNetworkInterfaces, ModifyIpv6AddressesAttribute, ModifyIpv6AddressesBandwidth, ReleaseIpv6Addresses。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Address | String | 是 | IPv6地址,形如:3402:4e00:20:100:0:8cd9:2a67:71f3 |
Primary | Boolean | 否 | 是否是主IP。 |
AddressId | String | 否 | EIP实例ID,形如:eip-hxlqja90。 |
Description | String | 否 | 描述信息。 |
IsWanIpBlocked | Boolean | 否 | 公网IP是否被封堵。 |
State | String | 否 | IPv6地址状态: PENDING:生产中 MIGRATING:迁移中 DELETING:删除中 AVAILABLE:可用的 |
Ipv6SubnetCidrBlock
IPv6子网段对象。
被如下接口引用:AssignIpv6SubnetCidrBlock, UnassignIpv6SubnetCidrBlock。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
SubnetId | String | 否 | 子网实例ID 。形如:subnet-pxir56ns 。 注意:此字段可能返回 null,表示取不到有效值。 示例值:subnet-pxir56ns |
Ipv6CidrBlock | String | 否 | IPv6 子网段。形如:3402:4e00:20:1001::/64 注意:此字段可能返回 null,表示取不到有效值。 示例值:3402:4e00:20:1001::/64 |
KeyPair
描述密钥对信息
被如下接口引用:CreateKeyPair。
名称 | 类型 | 描述 |
---|---|---|
KeyId | String | 密钥对的ID,是密钥对的唯一标识。 注意:此字段可能返回 null,表示取不到有效值。 示例值:skey-mv9yzyjj |
KeyName | String | 密钥对名称。 注意:此字段可能返回 null,表示取不到有效值。 示例值:TencentKeyp |
ProjectId | Integer | 密钥对所属的项目ID。 注意:此字段可能返回 null,表示取不到有效值。 示例值:null |
Description | String | 密钥对描述信息。 注意:此字段可能返回 null,表示取不到有效值。 示例值:test |
PublicKey | String | 密钥对的纯文本公钥。 注意:此字段可能返回 null,表示取不到有效值。 示例值:ssh-rsa AAAA**123== skey_437619 |
PrivateKey | String | 钥对的纯文本私钥。腾讯云不会保管私钥,请用户自行妥善保存。 注意:此字段可能返回 null,表示取不到有效值。 示例值:null |
AssociatedInstanceIds | Array of String | 钥关联的实例ID列表。 注意:此字段可能返回 null,表示取不到有效值。 示例值:[] |
CreatedTime | Timestamp ISO8601 | 创建时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2019-08-12T02:53:39Z |
Listener
负载均衡监听器
被如下接口引用:DescribeListeners。
名称 | 类型 | 描述 |
---|---|---|
ListenerId | String | 负载均衡监听器 ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:lbl-odt45qxx |
Protocol | String | 监听器协议 注意:此字段可能返回 null,表示取不到有效值。 示例值:HTTP |
Port | Integer | 监听器端口 注意:此字段可能返回 null,表示取不到有效值。 示例值:80 |
HealthCheck | HealthCheck | 监听器的健康检查信息 注意:此字段可能返回 null,表示取不到有效值。 |
Scheduler | String | 请求的调度方式 注意:此字段可能返回 null,表示取不到有效值。 示例值:WRR |
SessionExpireTime | Integer | 会话保持时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
ListenerName | String | 监听器的名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:name |
CreateTime | String | 监听器的创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-03-01 15:27:04 |
SessionType | String | 监听器的会话类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:NORMAL |
EndPort | Integer | 端口段结束端口 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
ListenerBackend
监听器后端
被如下接口引用:DescribeTargets。
名称 | 类型 | 描述 |
---|---|---|
ListenerId | String | 监听器 ID 注意:此字段可能返回 null,表示取不到有效值。 |
Protocol | String | 监听器的协议 注意:此字段可能返回 null,表示取不到有效值。 |
Port | Integer | 监听器的端口 注意:此字段可能返回 null,表示取不到有效值。 |
Targets | Array of Backend | 监听器上绑定的后端服务列表 注意:此字段可能返回 null,表示取不到有效值。 |
ListenerHealth
监听器健康状态
被如下接口引用:DescribeTargetHealth。
名称 | 类型 | 描述 |
---|---|---|
ListenerId | String | 监听器ID 注意:此字段可能返回 null,表示取不到有效值。 |
ListenerName | String | 监听器名称 注意:此字段可能返回 null,表示取不到有效值。 |
Protocol | String | 监听器的协议 注意:此字段可能返回 null,表示取不到有效值。 |
Port | Integer | 监听器的端口 注意:此字段可能返回 null,表示取不到有效值。 |
Rules | Array of RuleHealth | 监听器的转发规则列表 注意:此字段可能返回 null,表示取不到有效值。 |
LoadBalancer
负载均衡实例信息
被如下接口引用:DescribeLoadBalancers。
名称 | 类型 | 描述 |
---|---|---|
Region | String | 区域。 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-hangzhou |
Position | Position | 位置信息。 注意:此字段可能返回 null,表示取不到有效值。 |
LoadBalancerId | String | 负载均衡实例 ID。 注意:此字段可能返回 null,表示取不到有效值。 示例值:lb-1gmnrlgj |
LoadBalancerName | String | 负载均衡实例的名称。 注意:此字段可能返回 null,表示取不到有效值。 示例值:lb-xxxxx |
LoadBalancerType | String | 负载均衡实例的网络类型:OPEN:公网属性 注意:此字段可能返回 null,表示取不到有效值。 示例值:OPEN |
LoadBalancerVips | Array of String | 负载均衡实例的 VIP 列表。 注意:此字段可能返回 null,表示取不到有效值。 示例值:x.x.x.x |
Status | Integer | 负载均衡实例的状态,包括 0:创建中,1:正常运行。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
CreateTime | Timestamp | 负载均衡实例的创建时间。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2020-12-08 08:00:00 |
StatusTime | Timestamp | 负载均衡实例的上次状态转换时间。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2020-12-08 08:00:00 |
VpcId | String | 私有网络的 ID。 注意:此字段可能返回 null,表示取不到有效值。 示例值:vpc-mj65xxxx |
Tags | Array of TagInfo | 负载均衡实例的标签信息。 注意:此字段可能返回 null,表示取不到有效值。 |
VipIsp | String | 负载均衡IP地址所属的ISP。 注意:此字段可能返回 null,表示取不到有效值。 示例值:CTCC |
NetworkAttributes | LoadBalancerInternetAccessible | 负载均衡实例的网络属性。 注意:此字段可能返回 null,表示取不到有效值。 |
SecureGroups | Array of String | 安全组。 注意:此字段可能返回 null,表示取不到有效值。 示例值:sg-hx6dxxxx |
LoadBalancerPassToTarget | Boolean | 后端机器是否放通来自ELB的流量。 注意:此字段可能返回 null,表示取不到有效值。 示例值:false |
AddressIPv6 | String | 负载均衡实例的IPv6地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:2402:4e00:1000:4e00:0:920b:5519:d96d |
LoadBalancerHealth
负载均衡器健康状态
被如下接口引用:DescribeTargetHealth。
名称 | 类型 | 描述 |
---|---|---|
LoadBalancerId | String | 负载均衡实例ID 注意:此字段可能返回 null,表示取不到有效值。 |
LoadBalancerName | String | 负载均衡实例名称 注意:此字段可能返回 null,表示取不到有效值。 |
Listeners | Array of ListenerHealth | 监听器列表 注意:此字段可能返回 null,表示取不到有效值。 |
LoadBalancerInternetAccessible
负载均衡的带宽限制等信息。
被如下接口引用:CreateLoadBalancer, DescribeLoadBalancers, ModifyLoadBalancerAttributes。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
InternetMaxBandwidthOut | Integer | 否 | 最大出带宽,单位Mbps。默认值10 示例值:10 |
Module
模块信息
被如下接口引用:DescribeModule, DescribeModuleDetail。
名称 | 类型 | 描述 |
---|---|---|
ModuleId | String | 模块Id。 示例值:em-n212345 |
ModuleName | String | 模块名称。 示例值:t1_u2 |
ModuleState | String | 模块状态: NORMAL:正常。 DELETING:删除中 DELETEFAILED:删除失败。 示例值:NORMAL |
DefaultSystemDiskSize | Integer | 默认系统盘大小。 示例值:50 |
DefaultDataDiskSize | Integer | 默认数据盘大小。 示例值:0 |
InstanceTypeConfig | InstanceTypeConfig | 默认机型。 示例值: "InstanceTypeConfig": { "CpuModelName": "Intel Xeon Skylake 6133", "ExtInfo": "", "Frequency": "2.5 GHz", "GpuModelName": null, "InstanceFamilyConfig": { "InstanceFamily": "S5", "InstanceFamilyName": "标准型S5" }, "InstanceFamilyTypeConfig": { "InstanceFamilyType": "S", "InstanceFamilyTypeName": "标准型" }, "InstanceType": "S5.2XLARGE16", "Memory": 16, "Vcpu": 8, "Vgpu": null } |
DefaultImage | Image | 默认镜像。 |
CreateTime | String | 创建时间。 示例值:2020-02-18 16:59:51 |
DefaultBandwidth | Integer | 默认出带宽。 示例值:100 |
TagSet | Array of Tag | 标签集合。 注意:此字段可能返回 null,表示取不到有效值。 |
CloseIpDirect | Integer | 是否关闭IP直通。 示例值:0 |
SecurityGroupIds | Array of String | 默认安全组id列表。 示例值:["esg-ggdr1234","esg-15fd1234","esg-mt9b1234"] |
DefaultBandwidthIn | Integer | 默认入带宽。 示例值:100 |
UserData | String | 自定义脚本数据 示例值:AAA123***===SG |
SystemDisk | SystemDisk | 系统盘信息。 |
DataDisks | Array of DataDisk | 数据盘信息。 |
DisableWanIp | Integer | 是否禁止外网ip 示例值:1 |
ModuleCounter
节点统计数据
被如下接口引用:DescribeModuleDetail。
名称 | 类型 | 描述 |
---|---|---|
ISPCounterSet | Array of ISPCounter | 运营商统计信息列表 |
ProvinceNum | Integer | 省份数量 |
CityNum | Integer | 城市数量 |
NodeNum | Integer | 节点数量 |
InstanceNum | Integer | 实例数量 |
ModuleItem
模块列表Item信息
被如下接口引用:DescribeModule。
名称 | 类型 | 描述 |
---|---|---|
NodeInstanceNum | NodeInstanceNum | 节点实例统计信息 |
Module | Module | 模块信息 |
MonthNetwork
客户对应月份的带宽信息
被如下接口引用:DescribeMonthPeakNetwork。
名称 | 类型 | 描述 |
---|---|---|
ZoneInfo | ZoneInfo | 节点zone信息 |
Month | String | 带宽月份 示例"202103" 示例值:202103 |
BandwidthPkgId | String | 带宽包id 格式如"bwp-xxxxxxxx" 示例值:bwp-mm9aw7jq |
Isp | String | 运营商简称 取值范围"CUCC;CTCC;CMCC" 示例值:CMCC;CTCC;CUCC |
TrafficMaxIn | Float | 入网带宽包峰值,取值范围0.0-xxx.xxx 示例值:521.34 |
TrafficMaxOut | Float | 出网带宽包峰值,取值范围0.0-xxx.xxx 示例值:521.34 |
FeeTraffic | Float | 计费带宽,取值范围0.0-xxx.xxx 示例值:521.34 |
StartTime | String | 月计费带宽起始时间 格式"yyyy-mm-dd HH:mm:ss" 示例值:2021-02-28 00:00:00 |
EndTime | String | 月计费带宽结束时间 格式"yyyy-mm-dd HH:mm:ss" 示例值:2021-02-28 23:59:59 |
EffectiveDays | Integer | 月计费带宽实际有效天数 整形必须大于等于0 示例值:1 |
MonthDays | Integer | 指定月份的实际天数 实例 30 示例值:30 |
EffectiveDaysRate | Float | 有效天占比 保留小数点后四位0.2134 示例值:0.2134 |
BandwidthPkgType | String | 计费带宽包类型 实例"Address","LoadBalance","AddressIpv6" 示例值:Address |
NetworkInterface
弹性网卡
被如下接口引用:CreateNetworkInterface, DescribeNetworkInterfaces。
名称 | 类型 | 描述 |
---|---|---|
NetworkInterfaceId | String | 弹性网卡实例ID,例如:eni-f1xjkw1b。 示例值:eni-f1xjkw1b。 |
NetworkInterfaceName | String | 弹性网卡名称。 示例值:royhyangtest-main |
NetworkInterfaceDescription | String | 弹性网卡描述。 |
SubnetId | String | 子网实例ID。 示例值:subnet-nao8lfro |
VpcId | String | VPC实例ID。 示例值:vpc-2kx9z6h3 |
GroupSet | Array of String | 绑定的安全组。 注意:此字段可能返回 null,表示取不到有效值。 示例值:[ "sg-c2r7lnxh", "sg-f9ekbxeq" ] |
Primary | Boolean | 是否是主网卡。 示例值:true |
MacAddress | String | MAC地址。 示例值:20:90:6F:F5:34:C7 |
State | String | 弹性网卡状态: PENDING:创建中 AVAILABLE:可用的 ATTACHING:绑定中 DETACHING:解绑中 DELETING:删除中 示例值:AVAILABLE |
PrivateIpAddressSet | Array of PrivateIpAddressSpecification | 内网IP信息。 注意:此字段可能返回 null,表示取不到有效值。 示例值:[{ "Description": "", "Primary": true, ] |
Attachment | NetworkInterfaceAttachment | 绑定的云服务器对象。 注意:此字段可能返回 null,表示取不到有效值。 注意:此字段可能返回 null,表示取不到有效值。 示例值:{ "InstanceId": "ins-ymk3eje8", "DeviceIndex |
Zone | String | 可用区。 示例值:ap-guangzhou-2 |
CreatedTime | String | 创建时间。 示例值:"2021-01-07 16:32:55 |
Ipv6AddressSet | Array of Ipv6Address | IPv6地址列表。 注意:此字段可能返回 null,表示取不到有效值。 示例值:[ { "Description": "", "Primar |
TagSet | Array of Tag | 标签键值对。 注意:此字段可能返回 null,表示取不到有效值。 示例值:[ { "Key": "Version", "Value": |
EniType | Integer | 网卡类型。0 - 弹性网卡;1 - evm弹性网卡。 示例值:1 |
EcmRegion | String | EcmRegion ecm区域 示例值:ap-changchun-ecm-ct2 |
Business | String | 网卡绑定的子机类型:cvm,eks。 注意:此字段可能返回 null,表示取不到有效值。 示例值:eks |
NetworkInterfaceAttachment
弹性网卡绑定关系
被如下接口引用:CreateNetworkInterface, DescribeNetworkInterfaces。
名称 | 类型 | 描述 |
---|---|---|
InstanceId | String | 云主机实例ID。 |
DeviceIndex | Integer | 网卡在云主机实例内的序号。 |
InstanceAccountId | String | 云主机所有者账户信息。 |
AttachTime | String | 绑定时间。 |
NetworkStorageRange
网络硬盘上下限数据
被如下接口引用:DescribeConfig。
名称 | 类型 | 描述 |
---|---|---|
MaxBandwidth | Integer | 网络带宽上限 示例值:100 |
MaxSystemDiskSize | Integer | 数据盘上限 示例值:100 |
MinBandwidth | Integer | 网络带宽下限 示例值:10 |
MinSystemDiskSize | Integer | 数据盘下限 示例值:50 |
MaxDataDiskSize | Integer | 最大数据盘大小 示例值:500 |
MinDataDiskSize | Integer | 最小数据盘大小 示例值:50 |
SuggestBandwidth | Integer | 建议带宽 示例值:1000 |
SuggestDataDiskSize | Integer | 建议硬盘大小 示例值:100 |
SuggestSystemDiskSize | Integer | 建议系统盘大小 示例值:100 |
MaxVcpu | Integer | Cpu核数峰值 示例值:100 |
MinVcpu | Integer | Cpu核最小值 示例值:10 |
MaxVcpuPerReq | Integer | 单次请求最大cpu核数 示例值:10 |
PerBandwidth | Integer | 带宽步长 示例值:100 |
PerDataDisk | Integer | 数据盘步长 示例值:100 |
MaxModuleNum | Integer | 总模块数量 示例值:100 |
CBSSupported | Boolean | 是否支持cbs 示例值:false |
DiskNumLimit | Integer | 磁盘数量限制 示例值:50 |
Node
节点信息
被如下接口引用:DescribeNode。
名称 | 类型 | 描述 |
---|---|---|
ZoneInfo | ZoneInfo | zone信息。 |
Country | Country | 国家信息。 |
Area | Area | 区域信息。 |
Province | Province | 省份信息。 |
City | City | 城市信息。 |
RegionInfo | RegionInfo | Region信息。 |
ISPSet | Array of ISP | 运营商列表。 |
ISPNum | Integer | 运营商数量。 示例值:1 |
LBSupported | Boolean | 节点是否支持LB 示例值:false |
NodeInstanceNum
节点实例数量信息
被如下接口引用:DescribeModule。
名称 | 类型 | 描述 |
---|---|---|
NodeNum | Integer | 节点数量 |
InstanceNum | Integer | 实例数量 |
OperatorAction
操作Action
被如下接口引用:DescribeInstancesDeniedActions。
名称 | 类型 | 描述 |
---|---|---|
Action | String | 可执行操作 |
Code | String | 编码Code 注意:此字段可能返回 null,表示取不到有效值。 |
Message | String | 具体信息 注意:此字段可能返回 null,表示取不到有效值。 |
OsVersion
操作系统支持的类型。
被如下接口引用:DescribeImportImageOs。
名称 | 类型 | 描述 |
---|---|---|
OsName | String | 操作系统类型 |
OsVersions | Array of String | 支持的操作系统版本 注意:此字段可能返回 null,表示取不到有效值。 |
Architecture | Array of String | 支持的操作系统架构 注意:此字段可能返回 null,表示取不到有效值。 |
PackingQuotaGroup
一组相互关联的装箱配额,以实例类型的优先级排序,优先级高的在前
被如下接口引用:DescribePackingQuotaGroup。
名称 | 类型 | 描述 |
---|---|---|
Zone | String | 可用区 |
ZoneId | Integer | 可用区id |
ISPId | String | ISP id |
PackingQuotaInfos | Array of PackingQuotaInfo | 一组相互关联的装箱配额 |
PackingQuotaInfo
一组相关联的装箱配额信息
被如下接口引用:DescribePackingQuotaGroup。
名称 | 类型 | 描述 |
---|---|---|
InstanceType | String | 实例类型 |
PackingQuota | Integer | 装箱配额 |
PeakBase
峰值信息
被如下接口引用:DescribePeakBaseOverview。
名称 | 类型 | 描述 |
---|---|---|
PeakCpuNum | Integer | CPU峰值 |
PeakMemoryNum | Integer | 内存峰值 |
PeakStorageNum | Integer | 硬盘峰值 |
RecordTime | String | 记录时间 |
PeakFamilyInfo
PeakFamilyInfo 按机型类别分类的cpu等数据的峰值信息
被如下接口引用:DescribePeakBaseOverview。
名称 | 类型 | 描述 |
---|---|---|
InstanceFamily | InstanceFamilyTypeConfig | 机型类别信息。 |
PeakBaseSet | Array of PeakBase | 基础数据峰值信息。 |
PeakNetwork
峰值网络数据
被如下接口引用:DescribePeakNetworkOverview。
名称 | 类型 | 描述 |
---|---|---|
RecordTime | String | 记录时间。 示例值:2020-02-01 00:02:00 |
PeakInNetwork | String | 入带宽数据。 示例值:100.0 |
PeakOutNetwork | String | 出带宽数据。 示例值:100.0 |
ChargeNetwork | String | 计费带宽。单位bps 示例值:100.0 |
PeakNetworkRegionInfo
region维度的网络峰值信息
被如下接口引用:DescribePeakNetworkOverview。
名称 | 类型 | 描述 |
---|---|---|
Region | String | region信息 |
PeakNetworkSet | Array of PeakNetwork | 网络峰值集合 注意:此字段可能返回 null,表示取不到有效值。 |
PhysicalPosition
物理位置信息
被如下接口引用:DescribeInstances。
名称 | 类型 | 描述 |
---|---|---|
PosId | String | 机位 注意:此字段可能返回 null,表示取不到有效值。 示例值:B90CEE7***2455CA9F1A |
RackId | String | 机架 注意:此字段可能返回 null,表示取不到有效值。 示例值:18C8C045F6AFD0965***20127A9 |
SwitchId | String | 交换机 注意:此字段可能返回 null,表示取不到有效值。 示例值:99563FCAD565AC179***4EA92123 |
Placement
描述了实例的抽象位置,包括其所在的可用区,所属的项目,以及所属的独享集群的ID和名字。
被如下接口引用:CreateDisks, DescribeDisks, DescribeSnapshots。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Zone | String | 是 | 云硬盘所属的可用区。该参数也可以通过调用 DescribeZones 的返回值中的Zone字段来获取。 |
CageId | String | 否 | 围笼Id。作为入参时,表示对指定的CageId的资源进行操作,可为空。 作为出参时,表示资源所属围笼ID,可为空。 注意:此字段可能返回 null,表示取不到有效值。 |
ProjectId | Integer | 否 | 实例所属项目ID。该参数可以通过调用 DescribeProject 的返回值中的 projectId 字段来获取。不填为默认项目。 |
CdcName | String | 否 | 独享集群名字。作为入参时,忽略。作为出参时,表示云硬盘所属的独享集群名,可为空。 注意:此字段可能返回 null,表示取不到有效值。 |
CdcId | String | 否 | 实例所属的独享集群ID。作为入参时,表示对指定的CdcId独享集群的资源进行操作,可为空。 作为出参时,表示资源所属的独享集群的ID,可为空。 注意:此字段可能返回 null,表示取不到有效值。 |
Position
描述实例的位置相关信息。
被如下接口引用:DescribeInstances, DescribeLoadBalancers。
名称 | 类型 | 描述 |
---|---|---|
ZoneInfo | ZoneInfo | 实例所在的Zone的信息。 |
Country | Country | 实例所在的国家的信息。 |
Area | Area | 实例所在的Area的信息。 |
Province | Province | 实例所在的省份的信息。 |
City | City | 实例所在的城市的信息。 |
RegionInfo | RegionInfo | 实例所在的Region的信息。 |
Ipv6Supported | Boolean | 实例是否支持ipv6 注意:此字段可能返回 null,表示取不到有效值。 |
PriceDetail
描述cpu,内存等维度的价格
被如下接口引用:DescribePriceRunInstance。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Discount | Integer | 是 | 表示折扣,20 表示20%,打2折 示例值:20 |
DiscountPrice | Integer | 是 | 打折后价格,单位分 示例值:20 |
OriginalPrice | Integer | 是 | 折扣前价格,单位分 示例值:100 |
PrivateIPAddressInfo
实例的内网ip相关信息。
被如下接口引用:DescribeInstances。
名称 | 类型 | 描述 |
---|---|---|
PrivateIPAddress | String | 实例的内网ip。 注意:此字段可能返回 null,表示取不到有效值。 |
PrivateIpAddressSpecification
内网IP信息
被如下接口引用:AssignPrivateIpAddresses, CreateNetworkInterface, DescribeNetworkInterfaces, ModifyPrivateIpAddressesAttribute, RemovePrivateIpAddresses。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
PrivateIpAddress | String | 是 | 内网IP地址。 |
Primary | Boolean | 否 | 是否是主IP。 注意:此字段可能返回 null,表示取不到有效值。 |
PublicIpAddress | String | 否 | 公网IP地址。 |
AddressId | String | 否 | EIP实例ID,例如:eip-11112222。 |
Description | String | 否 | 内网IP描述信息。 |
IsWanIpBlocked | Boolean | 否 | 公网IP是否被封堵。 注意:此字段可能返回 null,表示取不到有效值。 |
State | String | 否 | IP状态: PENDING:生产中 MIGRATING:迁移中 DELETING:删除中 AVAILABLE:可用的 |
Province
省份信息
被如下接口引用:DescribeInstances, DescribeLoadBalancers, DescribeNode。
名称 | 类型 | 描述 |
---|---|---|
ProvinceId | String | 省份Id |
ProvinceName | String | 省份名称 |
PublicIPAddressInfo
实例的公网ip相关信息。
被如下接口引用:DescribeInstances。
名称 | 类型 | 描述 |
---|---|---|
ChargeMode | String | 计费模式。 |
PublicIPAddress | String | 实例的公网ip。 |
ISP | ISP | 实例的公网ip所属的运营商。 |
MaxBandwidthOut | Integer | 实例的最大出带宽上限,单位为Mbps。 |
MaxBandwidthIn | Integer | 实例的最大入带宽上限,单位为Mbps。 |
RegionInfo
Region和RegionName
被如下接口引用:DescribeInstances, DescribeLoadBalancers, DescribeNode。
名称 | 类型 | 描述 |
---|---|---|
Region | String | Region |
RegionName | String | Region名称 |
RegionId | Integer | RegionID |
Route
路由策略
被如下接口引用:CreateRouteTable, CreateRoutes, DeleteRoutes, DescribeRouteConflicts, DescribeRouteTables, ReplaceRoutes, ResetRoutes。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DestinationCidrBlock | String | 否 | 目的IPv4网段 示例值:10.2.2.0/24 |
GatewayType | String | 否 | 下一跳类型 NORMAL_CVM:普通云服务器; 示例值:NAT |
GatewayId | String | 否 | 下一跳地址 这里只需要指定不同下一跳类型的网关ID,系统会自动匹配到下一跳地址 当 GatewayType 为 EIP 时,GatewayId 固定值 '0' 示例值:nat-irmuq4z4 |
RouteItemId | String | 否 | 路由策略唯一ID 示例值:rti-mpgivlqt |
RouteDescription | String | 否 | 路由策略描述 示例值:TEST |
Enabled | Boolean | 否 | 是否启用 示例值:True |
RouteType | String | 否 | 路由类型,目前我们支持的类型有: USER:用户路由; NETD:网络探测路由,创建网络探测实例时,系统默认下发,不可编辑与删除; CCN:云联网路由,系统默认下发,不可编辑与删除。 用户只能添加和操作 USER 类型的路由。 示例值:CCN |
RouteId | Integer | 否 | 路由策略ID。IPv4路由策略ID是有意义的值,IPv6路由策略是无意义的值0。后续建议完全使用字符串唯一ID RouteItemId 操作路由策略示例值:1 |
RouteTableId | String | 否 | 路由表实例ID,例如:rtb-azd4dt1c。 示例值:rtb-azd4dt1c |
RouteConflict
路由冲突对象
被如下接口引用:DescribeRouteConflicts。
名称 | 类型 | 描述 |
---|---|---|
RouteTableId | String | 路由表实例ID |
DestinationCidrBlock | String | 要检查的与之冲突的目的端 |
ConflictSet | Array of Route | 冲突的路由策略列表 注意:此字段可能返回 null,表示取不到有效值。 |
RouteTable
路由表
被如下接口引用:CreateRouteTable, CreateRoutes, DescribeRouteTables。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
VpcId | String | 否 | VPC实例ID |
RouteTableId | String | 否 | 路由表实例ID |
RouteTableName | String | 否 | 路由表名称 |
AssociationSet | Array of RouteTableAssociation | 否 | 路由表关联关系 注意:此字段可能返回 null,表示取不到有效值。 |
RouteSet | Array of Route | 否 | IPv4路由策略集合 注意:此字段可能返回 null,表示取不到有效值。 |
Main | Boolean | 否 | 是否默认路由表 |
CreatedTime | String | 否 | 创建时间 |
RouteTableAssociation
路由表关联关系
被如下接口引用:CreateRouteTable, CreateRoutes, DescribeRouteTables。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
SubnetId | String | 否 | 子网实例ID |
RouteTableId | String | 否 | 路由表实例ID |
RuleHealth
转发规则及健康状态列表
被如下接口引用:DescribeTargetHealth。
名称 | 类型 | 描述 |
---|---|---|
Targets | Array of TargetHealth | 本规则上绑定的后端的健康检查状态 注意:此字段可能返回 null,表示取不到有效值。 |
RunEIPDirectServiceEnabled
IP直通相关的信息
被如下接口引用:ResetInstances, RunInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Enabled | Boolean | 否 | 是否开通IP直通。取值范围: TRUE:表示开通IP直通 FALSE:表示不开通IP直通 默认取值:TRUE。 windows镜像目前不支持IP直通。 |
RunMonitorServiceEnabled
云监控服务
被如下接口引用:ResetInstances, RunInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Enabled | Boolean | 否 | 是否开启。 |
RunSecurityServiceEnabled
云镜服务;
被如下接口引用:ResetInstances, RunInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Enabled | Boolean | 否 | 是否开启。 |
Version | Integer | 否 | 云镜版本:0 基础版,1 专业版。目前仅支持基础版 |
SecurityGroup
安全组对象
被如下接口引用:CreateSecurityGroup, DescribeSecurityGroups。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
SecurityGroupId | String | 是 | 安全组实例ID,例如:esg-ohuuioma。 |
SecurityGroupName | String | 是 | 安全组名称,可任意命名,但不得超过60个字符。 |
SecurityGroupDesc | String | 是 | 安全组备注,最多100个字符。 |
IsDefault | Boolean | 否 | 是否是默认安全组,默认安全组不支持删除。 |
CreatedTime | String | 否 | 安全组创建时间。 |
TagSet | Array of Tag | 否 | 标签键值对。 |
SecurityGroupAssociationStatistics
安全组关联的资源统计
被如下接口引用:DescribeSecurityGroupAssociationStatistics。
名称 | 类型 | 描述 |
---|---|---|
SecurityGroupId | String | 安全组实例ID。 |
ECM | Integer | ECM实例数。 |
Module | Integer | ECM模块数。 |
ENI | Integer | 弹性网卡实例数。 |
SG | Integer | 被安全组引用数。 |
CLB | Integer | 负载均衡实例数。 |
InstanceStatistics | Array of InstanceStatistic | 全量实例的绑定统计。 |
TotalCount | Integer | 所有资源的总计数(不包含被安全组引用数)。 |
SecurityGroupLimitSet
用户安全组配额限制
被如下接口引用:DescribeSecurityGroupLimits。
名称 | 类型 | 描述 |
---|---|---|
SecurityGroupLimit | Integer | 可创建安全组总数 |
SecurityGroupPolicyLimit | Integer | 安全组下的最大规则数 |
ReferedSecurityGroupLimit | Integer | 安全组下嵌套安全组规则数 |
SecurityGroupInstanceLimit | Integer | 单安全组关联实例数 |
InstanceSecurityGroupLimit | Integer | 实例关联安全组数 |
SecurityGroupModuleLimit | Integer | 单安全组关联的模块数 |
ModuleSecurityGroupLimit | Integer | 模块关联的安全组数 |
SecurityGroupPolicy
安全组规则对象
被如下接口引用:CreateSecurityGroupPolicies, DeleteSecurityGroupPolicies, DescribeSecurityGroupPolicies, ModifySecurityGroupPolicies, ReplaceSecurityGroupPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
PolicyIndex | Integer | 否 | 安全组规则索引号 示例值:1 |
Protocol | String | 否 | 协议, 取值: TCP,UDP, ICMP。 示例值:TCP |
Port | String | 否 | 端口(all, 离散port, range)。 示例值:80 |
ServiceTemplate | ServiceTemplateSpecification | 否 | 协议端口ID或者协议端口组ID。ServiceTemplate和Protocol+Port互斥。 |
CidrBlock | String | 否 | 网段或IP(互斥)。 示例值:0.0.0.0/0 |
SecurityGroupId | String | 否 | 安全组实例ID,例如:esg-ohuuioma。 示例值:esg-ohuuioma |
AddressTemplate | AddressTemplateSpecification | 否 | IP地址ID或者ID地址组ID。 |
Action | String | 否 | ACCEPT 或 DROP。 示例值:ACCEPT |
PolicyDescription | String | 否 | 安全组规则描述。 示例值:放通90端口 |
ModifyTime | String | 否 | 修改时间,例如 2020-07-22 19:27:23 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-05-11 16:46:38 |
Ipv6CidrBlock | String | 否 | 网段或IPv6(互斥)。 注意:此字段可能返回 null,表示取不到有效值。 示例值:::/0 |
SecurityGroupPolicySet
安全组规则集合
被如下接口引用:CreateSecurityGroupPolicies, DeleteSecurityGroupPolicies, DescribeSecurityGroupPolicies, ModifySecurityGroupPolicies, ReplaceSecurityGroupPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Version | String | 否 | 安全组规则当前版本。用户每次更新安全规则版本会自动加1,防止更新的路由规则已过期,不填不考虑冲突。 |
Egress | Array of SecurityGroupPolicy | 否 | 出站规则。其中出站规则和入站规则必须选一个。 |
Ingress | Array of SecurityGroupPolicy | 否 | 入站规则。其中出站规则和入站规则必须选一个。 |
ServiceTemplateSpecification
协议端口模板
被如下接口引用:CreateSecurityGroupPolicies, DeleteSecurityGroupPolicies, DescribeSecurityGroupPolicies, ModifySecurityGroupPolicies, ReplaceSecurityGroupPolicy。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ServiceId | String | 是 | 协议端口ID,例如:eppm-f5n1f8da。 |
ServiceGroupId | String | 是 | 协议端口组ID,例如:eppmg-f5n1f8da。 |
SimpleModule
Module的简要信息
被如下接口引用:DescribeInstances。
名称 | 类型 | 描述 |
---|---|---|
ModuleId | String | 模块ID |
ModuleName | String | 模块名称 |
Snapshot
描述了快照的详细信息
被如下接口引用:DescribeSnapshots。
名称 | 类型 | 描述 |
---|---|---|
Placement | Placement | 快照所在的位置。 |
CopyFromRemote | Boolean | 是否为跨地域复制的快照。取值范围: |
IsPermanent | Boolean | 是否为永久快照。取值范围: |
SnapshotName | String | 快照名称,用户自定义的快照别名。调用ModifySnapshotAttribute可修改此字段。 |
Percent | Integer | 快照创建进度百分比,快照创建成功后此字段恒为100。 |
Images | Array of Image | 快照关联的镜像列表。 |
ShareReference | Integer | 快照当前被共享数。 |
SnapshotType | String | 快照类型,目前该项取值可以为PRIVATE_SNAPSHOT或者SHARED_SNAPSHOT |
DiskSize | Integer | 创建此快照的云硬盘大小,单位GB。 |
DiskId | String | 创建此快照的云硬盘ID。 |
CopyingToRegions | Array of String | 快照正在跨地域复制的目的地域,默认取值为[]。 |
SnapshotId | String | 快照ID。 |
DiskUsage | String | 创建此快照的云硬盘类型。取值范围: |
Encrypt | Boolean | 是否为加密盘创建的快照。取值范围: |
CreateTime | Timestamp | 快照的创建时间。 |
ImageCount | Integer | 快照关联的镜像个数。 |
SnapshotState | String | 快照的状态。取值范围: |
DeadlineTime | String | 快照的到期时间。 示例值:2019-07-15 00:00:00 |
TimeStartShare | String | 快照开始共享的时间。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2020-10-23 10:17:21 |
SrcImage
镜像来源信息
被如下接口引用:DescribeImage, DescribeInstances, DescribeModuleDetail, DescribeSnapshots。
名称 | 类型 | 描述 |
---|---|---|
ImageId | String | 镜像id |
ImageName | String | 镜像名称 |
ImageOsName | String | 系统名称 |
ImageDescription | String | 镜像描述 |
Region | String | 区域 |
RegionID | Integer | 区域ID |
RegionName | String | 区域名称 |
InstanceName | String | 来源实例名称 |
InstanceId | String | 来源实例ID |
ImageType | String | 来源镜像类型 |
Subnet
子网对象
被如下接口引用:CreateSubnet, CreateVpc, DescribeDefaultSubnet, DescribeSubnets, DescribeVpcs。
名称 | 类型 | 描述 |
---|---|---|
VpcId | String | VPC实例ID。 |
SubnetId | String | 子网实例ID,例如:subnet-bthucmmy。 |
SubnetName | String | 子网名称。 |
CidrBlock | String | 子网的 IPv4 CIDR。 |
IsDefault | Boolean | 是否默认子网。 |
EnableBroadcast | Boolean | 是否开启广播。 |
RouteTableId | String | 路由表实例ID,例如:rtb-l2h8d7c2。 |
CreatedTime | String | 创建时间。 |
AvailableIpAddressCount | Integer | 可用IP数。 |
Ipv6CidrBlock | String | 子网的 IPv6 CIDR。 |
NetworkAclId | String | 关联ACLID |
IsRemoteVpcSnat | Boolean | 是否为 SNAT 地址池子网。 |
TagSet | Array of Tag | 标签键值对。 注意:此字段可能返回 null,表示取不到有效值。 |
Zone | String | 所在区域 |
ZoneName | String | 可用区名称 注意:此字段可能返回 null,表示取不到有效值。 |
InstanceCount | Integer | 实例数量 注意:此字段可能返回 null,表示取不到有效值。 |
VpcCidrBlock | String | VPC的 IPv4 CIDR。 注意:此字段可能返回 null,表示取不到有效值。 |
VpcIpv6CidrBlock | String | VPC的 IPv6 CIDR。 注意:此字段可能返回 null,表示取不到有效值。 |
Region | String | 地域 注意:此字段可能返回 null,表示取不到有效值。 |
ISPType | String | 运营商类型。'CMCC'-中国移动, 'CTCC'-中国电信, 'CUCC'-中国联调 注意:此字段可能返回 null,表示取不到有效值。 示例值:CMCC |
SystemDisk
用于描述系统盘。
被如下接口引用:CreateModule, DescribeModuleDetail, DescribePriceRunInstance, ModifyModuleConfig, RunInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DiskType | String | 否 | 硬盘类型。取值范围: - LOCAL_BASIC:本地硬盘; - CLOUD_PREMIUM:高性能云硬盘; 默认取值:CLOUD_BASIC。 示例值:CLOUD_PREMIUM |
DiskId | String | 否 | 硬盘ID。此参数暂不可用。 示例值:ldisk-1ly4f53h |
DiskSize | Integer | 否 | 硬盘容量大小。单位GB。 示例值:100 |
Tag
标签信息。
被如下接口引用:AllocateAddresses, CreateDisks, CreateModule, CreateNetworkInterface, CreateSecurityGroup, CreateSubnet, CreateVpc, DescribeDefaultSubnet, DescribeDisks, DescribeInstances, DescribeModuleDetail, DescribeNetworkInterfaces, DescribeSecurityGroups, DescribeSubnets, DescribeVpcs, ModifySubnetAttribute, ModifyVpcAttribute, RunInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Key | String | 是 | 标签健。 注意:此字段可能返回 null,表示取不到有效值。 示例值:tag-key |
Value | String | 是 | 标签值。 注意:此字段可能返回 null,表示取不到有效值。 示例值:tag-val |
TagInfo
标签信息。
被如下接口引用:CreateLoadBalancer, DescribeLoadBalancers。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TagKey | String | 否 | 标签的键。 |
TagValue | String | 否 | 标签的值。 |
TagSpecification
资源类型的Tag
被如下接口引用:CreateModule, RunInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ResourceType | String | 是 | 资源类型,目前仅支持"instance"、"module" |
Tags | Array of Tag | 是 | 标签列表 |
Target
负责均衡后端目标
被如下接口引用:BatchModifyTargetWeight, ModifyTargetPort, ModifyTargetWeight。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Port | Integer | 否 | 后端服务的监听端口 |
InstanceId | String | 否 | 子机ID |
Weight | Integer | 否 | 后端服务的转发权重,取值范围:[0, 100],默认为 10。 |
EniIp | String | 否 | 绑定弹性网卡时需要传入此参数,代表弹性网卡的IP,弹性网卡必须先绑定至子机,然后才能绑定到负载均衡实例。注意:参数 InstanceId 和 EniIp 只能传入一个且必须传入一个。 |
TargetHealth
后端的健康检查状态
被如下接口引用:DescribeTargetHealth。
名称 | 类型 | 描述 |
---|---|---|
IP | String | Target的内网IP 注意:此字段可能返回 null,表示取不到有效值。 |
Port | Integer | Target绑定的端口 注意:此字段可能返回 null,表示取不到有效值。 |
HealthStatus | Boolean | 当前健康状态,true:健康,false:不健康(包括尚未开始探测、探测中、状态异常等几种状态)。只有处于健康状态(且权重大于0),负载均衡才会向其转发流量。 注意:此字段可能返回 null,表示取不到有效值。 |
TargetId | String | Target的实例ID 注意:此字段可能返回 null,表示取不到有效值。 |
HealthStatusDetail | String | 当前健康状态的详细信息。如:Alive、Dead、Unknown、Close。Alive状态为健康,Dead状态为异常,Unknown状态包括尚未开始探测、探测中、状态未知,Close为未配置健康检查。 注意:此字段可能返回 null,表示取不到有效值。 |
TargetsWeightRule
目标和权重的描述信息
被如下接口引用:BatchModifyTargetWeight。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ListenerId | String | 否 | 负载均衡监听器 ID |
Targets | Array of Target | 否 | 要修改权重的后端机器列表 |
Weight | Integer | 否 | 后端服务新的转发权重,取值范围:0~100。 |
TaskInput
任务查询
被如下接口引用:DescribeTaskStatus。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Operation | String | 是 | 操作名,即API名称,比如:CreateImage |
TaskId | String | 是 | 任务id |
TaskOutput
任务查询出参
被如下接口引用:DescribeTaskStatus。
名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 任务id |
Message | String | 状态描述 |
Status | String | 状态值,SUCCESS/FAILED/OPERATING |
AddTime | String | 任务提交时间 |
EndTime | String | 任务结束时间 |
Operation | String | 操作名 |
VirtualPrivateCloud
私有网络相关信息配置。
被如下接口引用:DescribeInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
VpcId | String | 是 | 私有网络ID,形如vpc-xxx。 |
SubnetId | String | 是 | 私有网络子网ID,形如subnet-xxx。 |
AsVpcGateway | Boolean | 否 | 是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围: TRUE:表示用作公网网关 FALSE:表示不用作公网网关 默认取值:FALSE。 |
PrivateIpAddresses | Array of String | 否 | 私有网络子网 IP 数组,在创建实例、修改实例vpc属性操作中可使用此参数。 |
Ipv6AddressCount | Integer | 否 | 为弹性网卡指定随机生成的 IPv6 地址数量。 |
Ipv6SubnetIds | Array of String | 否 | runInstances接口创建三网ipv6地址使用 注意:此字段可能返回 null,表示取不到有效值。 |
VpcInfo
私有网络(VPC) 对象。
被如下接口引用:CreateVpc, DescribeVpcs。
名称 | 类型 | 描述 |
---|---|---|
VpcName | String | VPC名称。 示例值:1 |
VpcId | String | VPC实例ID,例如:vpc-azd4dt1c。 示例值:vpc-azd4dt1c |
CidrBlock | String | VPC的IPv4 CIDR。 示例值:10.0.0.0/16 |
IsDefault | Boolean | 是否默认VPC。 示例值:false |
EnableMulticast | Boolean | 是否开启组播。 示例值:false |
CreatedTime | String | 创建时间。 示例值:2021-01-20 15:25:11 |
DnsServerSet | Array of String | DNS列表。 注意:此字段可能返回 null,表示取不到有效值。 示例值:114.114.114.114 |
DomainName | String | DHCP域名选项值。 示例值:1 |
DhcpOptionsId | String | DHCP选项集ID。 示例值:1 |
EnableDhcp | Boolean | 是否开启DHCP。 示例值:true |
Ipv6CidrBlock | String | VPC的IPv6 CIDR。 示例值:1030:0:0:0:C9B4:FF12:48AA:1A2B/60 |
TagSet | Array of Tag | 标签键值对 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
AssistantCidrSet | Array of AssistantCidr | 辅助CIDR 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Region | String | 地域 示例值:ap-zhengzhou-ecm |
Description | String | 描述 示例值:1 |
RegionName | String | 地域中文名 示例值:郑州一区 |
SubnetCount | Integer | 包含子网数量 示例值:1 |
InstanceCount | Integer | 包含实例数量 示例值:0 |
Ipv6ISP | String | ipv6运营商 注意:此字段可能返回 null,表示取不到有效值。 示例值:CTCC |
Ipv6CidrBlockSet | Array of ISPIPv6CidrBlock | 多运营商IPv6 Cidr Block。 注意:此字段可能返回 null,表示取不到有效值。 |
ZoneInfo
Zone信息
被如下接口引用:DescribeInstances, DescribeLoadBalancers, DescribeMonthPeakNetwork, DescribeNode。
名称 | 类型 | 描述 |
---|---|---|
ZoneId | Integer | ZoneId |
ZoneName | String | ZoneName |
Zone | String | Zone |
ZoneInstanceCountISP
实例可用区及对应的实例创建数目及运营商的组合;
被如下接口引用:RunInstances。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Zone | String | 是 | 创建实例的可用区。 示例值:ap-dongguan-ecm-1 |
InstanceCount | Integer | 是 | 在当前可用区创建的实例数目。 示例值:1 |
ISP | String | 是 | 运营商如下: CTCC:中国电信 CUCC:中国联通 CMCC:中国移动 CMCC;CUCC;CTCC:三网;三网需要开通白名单,请直接联系腾讯云客服。 示例值:CMCC |
VpcId | String | 否 | 指定私有网络编号,SubnetId与VpcId必须同时指定或不指定 示例值:vpc-kcejgmxt |
SubnetId | String | 否 | 指定子网编号,SubnetId与VpcId必须同时指定或不指定 示例值:subnet-5r8jj7kg |
PrivateIpAddresses | Array of String | 否 | 指定主网卡内网IP。条件:SubnetId与VpcId必须同时指定,并且IP数量与InstanceCount相同,多IP主机副网卡内网IP在相同子网内通过DHCP获取。 示例值:10.212.2.153 |
Ipv6AddressCount | Integer | 否 | 为弹性网卡指定随机生成的IPv6地址数量,单网情况下是1,单网需要ISP 只能为单网运营商,三网情况3 示例值:1 |
Ipv6SubnetIds | Array of String | 否 | 指定创建三网ipv6地址,使用的subnet数组,只创建ipv4不创建ipv6和单网ipv6子网依然使用SubnetId字段; 该数组必须且仅支持传入三个不同的子网,并且这三个子网各自分配了电信、联通、移动三个运营商的其中一个IPV6 CIDR网段 示例值:sub-123456 |
ZoneInstanceInfo
Zone的实例信息
被如下接口引用:DescribeModuleDetail。
名称 | 类型 | 描述 |
---|---|---|
ZoneName | String | Zone名称 |
InstanceNum | Integer | 实例数量 |