数据结构

AttachDetail

挂载信息

被如下接口引用：DescribeInstancesDiskNum。

名称	类型	描述
InstanceId	String	实例ID 示例值："lhins-anxwfvxh"
AttachedDiskCount	Integer	实例已挂载弹性云盘数量 示例值：1
MaxAttachCount	Integer	可挂载弹性云盘数量 示例值：5

AutoMountConfiguration

自动挂载并初始化该数据盘。

被如下接口引用：CreateDisks。

名称	类型	必选	描述
InstanceId	String	是	待挂载的实例ID。指定的实例必须与指定的数据盘处于同一可用区，实例状态必须处于“运行中”状态，且实例必须支持自动化助手。 示例值：lhins-xxxxxx
MountPoint	String	否	实例内的挂载点。仅Linux操作系统的实例可传入该参数, 不传则默认挂载在“/data/disk”路径下。 示例值：/data/disk
FileSystemType	String	否	文件系统类型。取值: “ext4”、“xfs”。仅Linux操作系统的实例可传入该参数, 不传则默认为“ext4”。 示例值：ext4

Blueprint

描述了镜像信息。

被如下接口引用：DescribeBlueprintInstances, DescribeBlueprints, DescribeResetInstanceBlueprints。

名称	类型	描述
BlueprintId	String	镜像 ID ，是 Blueprint 的唯一标识。 示例值：lhbp-5exe07sc
DisplayTitle	String	镜像对外展示标题。 示例值：Discuz! Q
DisplayVersion	String	镜像对外展示版本。 示例值：1.0.0
Description	String	镜像描述信息。 注意：此字段可能返回 null，表示取不到有效值。 示例值：discuzq
OsName	String	操作系统名称。 示例值：CentOS 7.6 64bit
Platform	String	操作系统平台。 示例值：CENTOS
PlatformType	String	操作系统平台类型，如 LINUX_UNIX、WINDOWS。 示例值：LINUX_UNIX
BlueprintType	String	镜像类型，如 APP_OS、PURE_OS、PRIVATE。 示例值：APP_OS
ImageUrl	String	镜像图片 URL。 示例值：https://cloudcache.tencent-cloud.com/open_proj/proj_qcloud_v2/tc-console/tea-static-lighthouse/src/styles/slice/windows-server.svg
RequiredSystemDiskSize	Integer	镜像所需系统盘大小，单位 GB。 示例值：20
BlueprintState	String	镜像状态。 示例值：NORMAL
CreatedTime	Timestamp ISO8601	创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。 格式为： YYYY-MM-DDThh:mm:ssZ。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2021-02-02T09:16:16Z
BlueprintName	String	镜像名称。 示例值：discuzq
SupportAutomationTools	Boolean	镜像是否支持自动化助手。 示例值：true
RequiredMemorySize	Integer	镜像所需内存大小, 单位: GB 示例值：1
ImageId	String	CVM镜像共享到轻量应用服务器轻量应用服务器后的CVM镜像ID。 注意：此字段可能返回 null，表示取不到有效值。 示例值：img-cs2rrmp0
CommunityUrl	String	官方网站Url。 示例值：""
GuideUrl	String	指导文章Url。 示例值：""
SceneIdSet	Array of String	镜像关联使用场景Id列表。 注意：此字段可能返回 null，表示取不到有效值。 示例值：["lhsc-123456"]
DockerVersion	String	Docker版本号。 注意：此字段可能返回 null，表示取不到有效值。 示例值：20.10.5
BlueprintShared	Boolean	镜像是否已共享。 示例值：true

BlueprintInstance

描述镜像实例信息。

被如下接口引用：DescribeBlueprintInstances。

名称	类型	描述
Blueprint	Blueprint	镜像信息。
SoftwareSet	Array of Software	软件列表。
InstanceId	String	实例 ID。

BlueprintPrice

BlueprintPrice 自定义镜像的价格参数。

被如下接口引用：InquirePriceCreateBlueprint。

名称	类型	描述
OriginalBlueprintPrice	Float	镜像单价，原价。单位元。 示例值：0.008
OriginalPrice	Float	镜像总价，原价。单位元。 示例值：0.008
Discount	Float	折扣。 示例值：100
DiscountPrice	Float	镜像折扣后总价。单位元。 示例值：0.008

Bundle

套餐信息。

被如下接口引用：DescribeBundles, DescribeModifyInstanceBundles。

名称	类型	描述
BundleId	String	套餐 ID。 示例值：bundle_gen_01
Memory	Integer	内存大小，单位 GB。 示例值：1
SystemDiskType	String	系统盘类型。 取值范围： CLOUD_SSD：SSD 云硬盘 CLOUD_PREMIUM：高性能云硬盘 示例值：CLOUD_SSD
SystemDiskSize	Integer	系统盘大小。单位GB。 示例值：40
MonthlyTraffic	Integer	每月网络流量，单位 GB。 示例值：300
SupportLinuxUnixPlatform	Boolean	是否支持 Linux/Unix 平台。 示例值：true
SupportWindowsPlatform	Boolean	是否支持 Windows 平台。 示例值：true
Price	Price	套餐当前单位价格信息。 示例值： { "InstancePrice": { "OriginalBundlePrice
CPU	Integer	CPU 核数。 示例值：1
InternetMaxBandwidthOut	Integer	峰值带宽，单位 Mbps。 示例值：3
InternetChargeType	String	网络计费类型。 示例值：TRAFFIC_POSTPAID_BY_HOUR
BundleSalesState	String	套餐售卖状态,取值:‘AVAILABLE’(可用) , ‘SOLD_OUT’(售罄) 示例值：SOLD_OUT
BundleType	String	套餐类型。 取值范围： STARTER_BUNDLE：入门型 GENERAL_BUNDLE：通用型 ENTERPRISE_BUNDLE：企业型 STORAGE_BUNDLE：存储型 EXCLUSIVE_BUNDLE：专属型 HK_EXCLUSIVE_BUNDLE：香港专属型 CAREFREE_BUNDLE：无忧型 BEFAST_BUNDLE：蜂驰型 示例值：GENERAL_BUNDLE
BundleTypeDescription	String	套餐类型描述信息。 注意：此字段可能返回 null，表示取不到有效值。 示例值：通用型
BundleDisplayLabel	String	套餐展示标签. 取值范围: "ACTIVITY": 活动套餐, "NORMAL": 普通套餐 "CAREFREE": 无忧套餐 示例值：NORMAL

CcnAttachedInstance

云联网关联的实例列表。

被如下接口引用：DescribeCcnAttachedInstances。

名称	类型	描述
CcnId	String	云联网ID。 示例值：ccn-f49l6u0z
CidrBlock	Array of String	关联实例CIDR。 示例值： ["10.0.0.0/16"]
State	String	关联实例状态： • PENDING：申请中 • ACTIVE：已连接 • EXPIRED：已过期 • REJECTED：已拒绝 • DELETED：已删除 • FAILED：失败的（2小时后将异步强制解关联） • ATTACHING：关联中 • DETACHING：解关联中 • DETACHFAILED：解关联失败（2小时后将异步强制解关联） 示例值：PENDING
AttachedTime	Timestamp	关联时间。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2021-05-08 17:21:05
Description	String	备注 示例值：Lighthouse attach ccn instance

Command

用户执行TAT命令的数据结构。

被如下接口引用：CreateInstances。

名称	类型	必选	描述
Content	String	是	Base64编码后的命令内容，长度不可超过64KB。 示例值：bHM=
Timeout	Integer	否	命令超时时间，默认60秒。取值范围[1, 86400]。 示例值：60
WorkingDirectory	String	否	命令执行路径，对于 SHELL 命令默认为 /root，对于 POWERSHELL 命令默认为 C:\Program Files\qcloud\tat_agent\workdir。 示例值：/root
Username	String	否	在 Lighthouse 实例中执行命令的用户名称。 默认情况下，在 Linux 实例中以 root 用户执行命令；在Windows 实例中以 System 用户执行命令。 示例值：root

ContainerEnv

容器环境变量

被如下接口引用：CreateInstances, DescribeDockerContainerConfiguration, ModifyDockerContainer, RerunDockerContainer, ResetInstance, RunDockerContainers。

名称	类型	必选	描述
Key	String	是	环境变量Key 示例值：K1
Value	String	是	环境变量值 示例值：V1

DataDiskPrice

数据盘价格

被如下接口引用：InquirePriceRenewInstances。

名称	类型	描述
DiskId	String	云硬盘ID。 示例值：lhdisk-f3vgfci1
OriginalDiskPrice	Float	云硬盘单价。 示例值：0.8
OriginalPrice	Float	云硬盘总价。 示例值：0.8
Discount	Float	折扣。 示例值：0.5
DiscountPrice	Float	折后总价。 示例值：0.4
InstanceId	String	数据盘挂载的实例ID。 注意：此字段可能返回 null，表示取不到有效值。 示例值：lhins-abcdef

DeniedAction

限制操作。

被如下接口引用：DescribeDiskBackupsDeniedActions, DescribeDisksDeniedActions, DescribeInstancesDeniedActions, DescribeSnapshotsDeniedActions。

名称	类型	描述
Action	String	限制操作名。 示例值：StartInstances
Code	String	限制操作消息码。 示例值：UnsupportedOperation.InvalidInstanceState
Message	String	限制操作消息。 示例值：The request does not support the instance lhins-ruy9d2tw which is in the state of RUNNING.

DetailPrice

计费项目明细。

被如下接口引用：InquirePriceCreateDisks, InquirePriceRenewDisks。

名称	类型	描述
PriceName	String	描述计费项目名称，目前取值 "DiskSpace"代表云硬盘空间收费项。 "DiskBackupQuota"代表云硬盘备份点配额收费项。 示例值：DiskSpace
OriginUnitPrice	Float	云硬盘计费项维度单价。 示例值：1.1
OriginalPrice	Float	云硬盘计费项维度总价。 示例值：2.2
Discount	Float	云硬盘在计费项维度折扣。 示例值：0.8
DiscountPrice	Float	云硬盘在计费项维度折后总价。 示例值：2.1

DiscountDetail

套餐折扣详情（仅用于控制台调用询价相关接口返回）。

被如下接口引用：DescribeBundleDiscount, DescribeDiskDiscount, InquirePriceRenewInstances。

名称	类型	描述
TimeSpan	Integer	计费时长。 示例值：1
TimeUnit	String	计费单元。 示例值：m
TotalCost	Float	总价。 示例值：50
RealTotalCost	Float	折后总价。 示例值：50
Discount	Float	折扣。 示例值：100
PolicyDetail	PolicyDetail	具体折扣详情。

Disk

磁盘信息

被如下接口引用：DescribeDisks。

名称	类型	描述
DiskId	String	磁盘ID 示例值：lhdisk-p1zflrif
InstanceId	String	实例ID 示例值：lhins-anxwfvxh
Zone	String	可用区 示例值：ap-guangzhou-1
DiskName	String	磁盘名称 示例值：disk-name
DiskUsage	String	磁盘类型 示例值：DATA_DISK
DiskType	String	磁盘介质类型 示例值：CLOUD_SSD
DiskChargeType	String	磁盘付费类型 示例值：PREPAID
DiskSize	Integer	磁盘大小 示例值：20
RenewFlag	String	续费标识 示例值：NOTIFY_AND_MANUAL_RENEW
DiskState	String	磁盘状态，取值范围： PENDING：创建中。 UNATTACHED：未挂载。 ATTACHING：挂载中。 ATTACHED：已挂载。 DETACHING：卸载中。 SHUTDOWN：已隔离。 CREATED_FAILED：创建失败。 TERMINATING：销毁中。 DELETING：删除中。 FREEZING：冻结中。 示例值：UNATTACHED
Attached	Boolean	磁盘挂载状态 示例值：False
DeleteWithInstance	Boolean	是否随实例释放 示例值：False
LatestOperation	String	上一次操作 示例值：CreateDisks
LatestOperationState	String	上一次操作状态 示例值：SUCCESS
LatestOperationRequestId	String	上一次请求ID 示例值：b786faac-d27b-4f70-a52e-3ae725e0f639
CreatedTime	Timestamp ISO8601	创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。 格式为： YYYY-MM-DDThh:mm:ssZ。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2021-08-25T08:50:57Z
ExpiredTime	Timestamp ISO8601	到期时间。按照 ISO8601 标准表示，并且使用 UTC 时间。 格式为： YYYY-MM-DDThh:mm:ssZ。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2021-08-25T08:50:57Z
IsolatedTime	Timestamp ISO8601	隔离时间。按照 ISO8601 标准表示，并且使用 UTC 时间。 格式为： YYYY-MM-DDThh:mm:ssZ。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2021-08-25T08:50:57Z
DiskBackupCount	Integer	云硬盘的已有备份点数量。 示例值：1
DiskBackupQuota	Integer	云硬盘的备份点配额数量。 示例值：1

DiskBackup

描述了云硬盘备份点相关信息。

被如下接口引用：DescribeDiskBackups。

名称	类型	描述
DiskBackupId	String	云硬盘备份点ID。 示例值：lhbak-nuen5foj
DiskUsage	String	创建此云硬盘备份点的云硬盘类型。取值： DATA_DISK：数据盘 示例值：DATA_DISK
DiskId	String	创建此云硬盘备份点的云硬盘 ID。 示例值：lhdisk-nbebddz8
DiskSize	Integer	创建此云硬盘备份点的云硬盘大小，单位 GB。 示例值：200
DiskBackupName	String	云硬盘备份点名称，用户自定义的云硬盘备份点别名。 示例值：lhdisk-nbebddz8-data-disk-062
DiskBackupState	String	云硬盘备份点的状态。取值范围： NORMAL：正常。 CREATING：创建中。 ROLLBACKING：回滚中。 DELETING：删除中。 示例值：NORMAL
Percent	Integer	创建或回滚云硬盘备份点进度百分比，成功后此字段取值为 100。 示例值：90
LatestOperation	String	上一次操作 注意：此字段可能返回 null，表示取不到有效值。 示例值：ApplyDiskBackup
LatestOperationState	String	上一次操作状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：SUCCESS
LatestOperationRequestId	String	上一次请求ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：cd7f9d77-c19b-4490-8d5e-42a776383f90
CreatedTime	Timestamp ISO8601	创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。 格式为： YYYY-MM-DDThh:mm:ssZ。 示例值：2022-06-23T09:19:05Z

DiskBackupDeniedActions

云硬盘备份点操作限制列表。

被如下接口引用：DescribeDiskBackupsDeniedActions。

名称	类型	描述
DiskBackupId	String	云硬盘备份点ID。 示例值：DiskBackupId
DeniedActions	Array of DeniedAction	操作限制列表。

DiskChargePrepaid

云硬盘包年包月相关参数设置

被如下接口引用：CreateDisks, InquirePriceCreateDisks。

名称	类型	必选	描述
Period	Integer	是	新购周期。 示例值：1
RenewFlag	String	否	自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费，用户需要手动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不自动续费，且不通知 默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，云硬盘到期后将按月自动续费。 示例值：NOTIFY_AND_AUTO_RENEW
TimeUnit	String	否	新购单位. 默认值: "m"。 示例值：m

DiskConfig

云硬盘配置

被如下接口引用：DescribeDiskConfigs。

名称	类型	描述
Zone	String	可用区。 示例值：ap-guangzhou-1
DiskType	String	云硬盘类型。 示例值：CLOUD_SSD
DiskSalesState	String	云硬盘可售卖状态。 示例值：AVAILABLE
MaxDiskSize	Integer	最大云硬盘大小。 示例值：1000
MinDiskSize	Integer	最小云硬盘大小。 示例值：10
DiskStepSize	Integer	云硬盘步长。 示例值：10

DiskDeniedActions

磁盘操作限制列表详细信息

被如下接口引用：DescribeDisksDeniedActions。

名称	类型	描述
DiskId	String	云硬盘ID。 示例值：lhdisk-eobj8huv
DeniedActions	Array of DeniedAction	操作限制列表。

DiskPrice

云硬盘价格

被如下接口引用：InquirePriceCreateDisks, InquirePriceRenewDisks。

名称	类型	描述
OriginalDiskPrice	Float	云硬盘单价。 示例值：1.1
OriginalPrice	Float	云硬盘总价。 示例值：2.2
Discount	Float	折扣。 示例值：0.8
DiscountPrice	Float	折后总价。 示例值：2.1
DetailPrices	Array of DetailPrice	计费项目明细列表。

DiskReturnable

可退还云硬盘详细信息

被如下接口引用：DescribeDisksReturnable。

名称	类型	描述
DiskId	String	云硬盘ID。 示例值：lhdisk-eobj8huv
IsReturnable	Boolean	云硬盘是否可退还。 示例值：true
ReturnFailCode	Integer	云硬盘退还失败错误码。 示例值：0
ReturnFailMessage	String	云硬盘退还失败错误信息。 示例值：""

DockerActivity

Docker活动信息

被如下接口引用：DescribeDockerActivities。

名称	类型	描述
ActivityId	String	活动ID。 示例值：lhda-9qq8eu90
ActivityName	String	活动名称。 示例值：RunDockerContainer
ActivityState	String	活动状态。取值范围： INIT：表示初始化，活动尚未执行 OPERATING：表示活动执行中 SUCCESS：表示活动执行成功 FAILED：表示活动执行失败 示例值：INIT
ActivityCommandOutput	String	活动执行的命令输出，以base64编码。 示例值：aGVsbG8=
ContainerIds	Array of String	容器ID列表。 示例值：["838b0781925f8ea98ff1831c60f1e6178c21923192ec773cb0cb8427fe196fa3"]
CreatedTime	Timestamp ISO8601	创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。 示例值：2020-04-28T03:46:09Z
EndTime	Timestamp ISO8601	结束时间。按照 ISO8601 标准表示，并且使用 UTC 时间。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2020-04-28T03:46:09Z

DockerContainer

Docker容器信息

被如下接口引用：DescribeDockerContainers。

名称	类型	描述
ContainerId	String	容器ID 示例值：928f59ce31678d9c00955e655231e594945d11058517d1935c7f4ec53c6cde7c
ContainerName	String	容器名称 示例值：Container1
ContainerImage	String	容器镜像地址 示例值：nginx
Command	String	容器Command 示例值：ls -l
Status	String	容器状态描述 示例值：Up 23 hours
State	String	容器状态，和docker的容器状态保持一致，当前取值有：created, restarting, running, removing, paused, exited, or dead 示例值：running
PublishPortSet	Array of DockerContainerPublishPort	容器端口主机端口映射列表 示例值：[{"ContainerPort":80,"HostPort":8081}]
VolumeSet	Array of DockerContainerVolume	容器挂载本地卷列表 示例值：[{"ContainerPath":"/data/nginx","HostPath":"/data/nginx"}]
CreatedTime	Timestamp ISO8601	创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。 示例值：2020-04-28T03:46:09Z

DockerContainerConfiguration

Docker容器创建时的配置

被如下接口引用：CreateInstances, DescribeDockerContainerConfiguration, RerunDockerContainer, ResetInstance, RunDockerContainers。

名称	类型	必选	描述
ContainerImage	String	是	容器镜像地址 示例值：nginx
ContainerName	String	否	容器名称 示例值：Container1
Envs	Array of ContainerEnv	否	环境变量列表 示例值：[{"Key":"Key1","Value":"Value1"}]
PublishPorts	Array of DockerContainerPublishPort	否	容器端口主机端口映射列表 示例值：[{"ContainerPort":80,"HostPort":8081}]
Volumes	Array of DockerContainerVolume	否	容器加载本地卷列表 示例值：[{"ContainerPath":"/data/nginx","HostPath":"/data/nginx"}]
Command	String	否	运行的命令 示例值：ls -l
RestartPolicy	String	否	容器重启策略 示例值：always

DockerContainerPublishPort

Docker容器映射的端口

被如下接口引用：CreateInstances, DescribeDockerContainerConfiguration, DescribeDockerContainers, ModifyDockerContainer, RerunDockerContainer, ResetInstance, RunDockerContainers。

名称	类型	必选	描述
HostPort	Integer	是	主机端口 示例值：80
ContainerPort	Integer	是	容器端口 示例值：80
Ip	String	否	对外绑定IP，默认0.0.0.0 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.0.0.0
Protocol	String	否	协议，默认tcp，支持tcp/udp/sctp 注意：此字段可能返回 null，表示取不到有效值。 示例值：tcp

DockerContainerVolume

Docker容器挂载卷

被如下接口引用：CreateInstances, DescribeDockerContainerConfiguration, DescribeDockerContainers, ModifyDockerContainer, RerunDockerContainer, ResetInstance, RunDockerContainers。

名称	类型	必选	描述
ContainerPath	String	是	容器路径 示例值：/data/container
HostPath	String	否	主机路径 示例值：/data/host

Filter

描述键值对过滤器，用于条件过滤查询。例如过滤名称等

• 若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。
• 若同一个Filter存在多个Values，同一Filter下Values间的关系为逻辑或（OR）关系。

以DescribeInstances接口的Filter为例。若我们需要查询实例名称（instance-name）为test 并且 实例内网IP（private-ip-address）为10.10.10.10的实例时，可如下实现：

Filters.0.Name=instance-name
&Filters.0.Values.0=test
&Filters.1.Name=private-ip-address
&Filters.1.Values.0=10.10.10.10

被如下接口引用：DescribeBlueprints, DescribeBundles, DescribeDiskBackups, DescribeDiskConfigs, DescribeDisks, DescribeDockerContainers, DescribeFirewallTemplates, DescribeInstances, DescribeKeyPairs, DescribeModifyInstanceBundles, DescribeResetInstanceBlueprints, DescribeSnapshots。

名称	类型	必选	描述
Name	String	是	需要过滤的字段。 示例值：bundle-id
Values	Array of String	是	字段的过滤值。 示例值：['bundle_ntp_small2_100']

FirewallRule

描述防火墙规则信息。

被如下接口引用：CreateFirewallRules, CreateFirewallTemplate, CreateFirewallTemplateRules, DeleteFirewallRules, DescribeFirewallTemplateApplyRecords, ModifyFirewallRuleDescription, ModifyFirewallRules, ReplaceFirewallTemplateRule, ResetFirewallTemplateRules。

名称	类型	必选	描述
Protocol	String	是	协议，取值：TCP，UDP，ICMP，ALL。 示例值：TCP
Port	String	否	端口，取值：ALL，单独的端口，逗号分隔的离散端口，减号分隔的端口范围。 示例值：80
CidrBlock	String	否	IPv4网段或 IPv4地址(互斥)。 示例值：0.0.0.0/0。 和Ipv6CidrBlock互斥，两者都不指定时，如果Protocol不是ICMPv6，则取默认值0.0.0.0/0。 示例值：0.0.0.0/0
Action	String	否	取值：ACCEPT，DROP。默认为 ACCEPT。 示例值：ACCEPT
FirewallRuleDescription	String	否	防火墙规则描述。 示例值：firewallrule description

FirewallRuleInfo

描述防火墙规则详细信息。

被如下接口引用：DescribeFirewallRules, DescribeFirewallRulesTemplate, DescribeFirewallTemplateRules。

名称	类型	描述
AppType	String	应用类型，取值：自定义，HTTP(80)，HTTPS(443)，Linux登录(22)，Windows登录(3389)，MySQL(3306)，SQL Server(1433)，全部TCP，全部UDP，Ping-ICMP，ALL。 示例值：HTTP(80)
Protocol	String	协议，取值：TCP，UDP，ICMP，ALL。 示例值：TCP
Port	String	端口，取值：ALL，单独的端口，逗号分隔的离散端口，减号分隔的端口范围。 示例值：80
CidrBlock	String	IPv4网段或 IPv4地址(互斥)。 示例值：0.0.0.0/0。 和Ipv6CidrBlock互斥，两者都不指定时，如果Protocol不是ICMPv6，则取默认值0.0.0.0/0。 示例值：0.0.0.0/0
Action	String	取值：ACCEPT，DROP。默认为 ACCEPT。 示例值：ACCEPT
FirewallRuleDescription	String	防火墙规则描述。 示例值：''

FirewallTemplate

防火墙模板信息。

被如下接口引用：DescribeFirewallTemplates。

名称	类型	描述
TemplateId	String	模板Id。 示例值：lhft-xxxxxx
TemplateName	String	模板名称。 示例值：DemoTemplate
TemplateType	String	模板类型。 示例值：PUBLIC
TemplateState	String	模板状态。 示例值：NORMAL
CreatedTime	Timestamp ISO8601	模板创建时间。 示例值：2021-09-30T04:12:31Z

FirewallTemplateApplyRecord

防火墙模板应用记录。

被如下接口引用：DescribeFirewallTemplateApplyRecords。

名称	类型	描述
TaskId	String	任务ID。 示例值：lgtk-xxxxxxxx
ApplyTime	Timestamp ISO8601	应用模板的时间。 示例值：2023-06-21T02:47:42Z
TemplateRuleSet	Array of FirewallTemplateRule	模板规则列表。
ApplyState	String	应用模板的执行状态。 示例值：SUCCESS
SuccessCount	Integer	应用成功的实例数量。 示例值：10
FailedCount	Integer	应用失败的实例数量。 示例值：0
RunningCount	Integer	正在应用中的实例数量。 示例值：0
ApplyDetailSet	Array of FirewallTemplateApplyRecordDetail	应用模板的执行细节。

FirewallTemplateApplyRecordDetail

防火墙模板应用记录详情。

被如下接口引用：DescribeFirewallTemplateApplyRecords。

名称	类型	描述
Instance	InstanceIdentifier	实例标识信息。
ApplyState	String	防火墙模板应用状态。 示例值：SUCCESS
ErrorMessage	String	防火墙模板应用错误信息。 示例值：""

FirewallTemplateRule

防火墙模板规则信息

被如下接口引用：DescribeFirewallTemplateApplyRecords。

名称	类型	描述
TemplateRuleId	String	防火墙模板规则ID。 示例值：lhftr-xxxxxxxxxx
FirewallRule	FirewallRule	防火墙规则。

FirewallTemplateRuleInfo

防火墙模板规则信息

被如下接口引用：DescribeFirewallTemplateRules。

名称	类型	描述
TemplateRuleId	String	防火墙模板规则ID。 示例值：lhftr-abcde12345
FirewallRuleInfo	FirewallRuleInfo	防火墙规则信息。

GeneralResourceQuota

描述通用资源配额信息。

被如下接口引用：DescribeGeneralResourceQuotas。

名称	类型	描述
ResourceName	String	资源名称。
ResourceQuotaAvailable	Integer	资源当前可用数量。
ResourceQuotaTotal	Integer	资源总数量。

Instance

描述了实例信息。

被如下接口引用：DescribeInstances。

名称	类型	描述
InstanceId	String	实例 ID。 示例值：lhins-muuz7kis
BundleId	String	套餐 ID。 示例值：bundle_bw_small1_1
BlueprintId	String	镜像 ID。 示例值：lhbp-abcd1234
CPU	Integer	实例的 CPU 核数，单位：核。 示例值：2
Memory	Integer	实例内存容量，单位：GB 。 示例值：2
InstanceName	String	实例名称。 示例值：green-lh-test
InstanceChargeType	String	实例计费模式。取值范围： PREPAID：表示预付费，即包年包月。 示例值：PREPAID
SystemDisk	SystemDisk	实例系统盘信息。
PrivateAddresses	Array of String	实例主网卡的内网 IP。 注意：此字段可能返回 空，表示取不到有效值。 示例值：["10.0.2.13"]
PublicAddresses	Array of String	实例主网卡的公网 IP。 注意：此字段可能返回 空，表示取不到有效值。 示例值：["43.128.117.26"]
InternetAccessible	InternetAccessible	实例带宽信息。
RenewFlag	String	自动续费标识。取值范围： NOTIFY_AND_MANUAL_RENEW：表示通知即将过期，但不自动续费 NOTIFY_AND_AUTO_RENEW：表示通知即将过期，而且自动续费 。 示例值：NOTIFY_AND_MANUAL_RENEW
LoginSettings	LoginSettings	实例登录设置。
InstanceState	String	实例状态。取值范围： PENDING：表示创建中 LAUNCH_FAILED：表示创建失败 RUNNING：表示运行中 STOPPED：表示关机 STARTING：表示开机中 STOPPING：表示关机中 REBOOTING：表示重启中 SHUTDOWN：表示停止待销毁 TERMINATING：表示销毁中 DELETING：表示删除中 FREEZING：表示冻结中 ENTER_RESCUE_MODE：表示进入救援模式中 RESCUE_MODE：表示救援模式 EXIT_RESCUE_MODE：表示退出救援模式中 示例值：RUNNING
Uuid	String	实例全局唯一 ID。 示例值：1db916fc-ac02-498c-9fe0-ce60003ebcbf
LatestOperation	String	实例的最新操作。例：StopInstances、ResetInstance。注意：此字段可能返回 空值，表示取不到有效值。 示例值：StartInstances
LatestOperationState	String	实例的最新操作状态。取值范围： SUCCESS：表示操作成功 OPERATING：表示操作执行中 FAILED：表示操作失败 注意：此字段可能返回 空值，表示取不到有效值。 示例值：SUCCESS
LatestOperationRequestId	String	实例最新操作的唯一请求 ID。 注意：此字段可能返回 空值，表示取不到有效值。 示例值：f498d99d-2647-4c1c-a234-36f0e082e7ba
LatestOperationStartedTime	Timestamp ISO8601	实例最新操作的开始时间。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2023-12-01T06:34:59Z
IsolatedTime	Timestamp ISO8601	隔离时间。按照 ISO8601 标准表示，并且使用 UTC 时间。 格式为： YYYY-MM-DDThh:mm:ssZ。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2023-12-01T06:34:59Z
CreatedTime	Timestamp ISO8601	创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。 格式为： YYYY-MM-DDThh:mm:ssZ。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2023-12-01T06:34:59Z
ExpiredTime	Timestamp ISO8601	到期时间。按照 ISO8601 标准表示，并且使用 UTC 时间。 格式为： YYYY-MM-DDThh:mm:ssZ 。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-01-01T06:34:59Z
PlatformType	String	操作系统平台类型，如 LINUX_UNIX、WINDOWS。 示例值：LINUX_UNIX
Platform	String	操作系统平台。 示例值：CENTOS
OsName	String	操作系统名称。 示例值：CentOS 7.6 64bit
Zone	String	可用区。 示例值：ap-singapore-3
Tags	Array of Tag	实例绑定的标签列表。
InstanceRestrictState	String	实例封禁状态。取值范围： NORMAL实例正常。 NETWORK_RESTRICT：网络封禁。 示例值：NETWORK_RESTRICT
InitInvocationId	String	创建实例后自动执行TAT命令的调用ID。 示例值：inv-adtgj412l
InstanceViolationDetail	InstanceViolationDetail	实例违规详情。 注意：此字段可能返回 null，表示取不到有效值。

InstanceChargePrepaid

描述了实例的计费模式

被如下接口引用：CreateInstances, InquirePriceCreateInstances, InquirePriceRenewInstances, RenewInstances。

名称	类型	必选	描述
Period	Integer	是	购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60。 示例值：1
RenewFlag	String	否	自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费，用户需要手动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不自动续费，且不通知 默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，实例到期后将按月自动续费。 示例值：NOTIFY_AND_AUTO_RENEW

InstanceDeniedActions

实例操作限制列表。

被如下接口引用：DescribeInstancesDeniedActions。

名称	类型	描述
InstanceId	String	实例 ID。 注意：此字段可能返回 null，表示取不到有效值。 示例值：lhins-abcd1234
DeniedActions	Array of DeniedAction	操作限制列表。

InstanceIdentifier

实例标识信息。

被如下接口引用：ApplyFirewallTemplate, DescribeFirewallTemplateApplyRecords。

名称	类型	必选	描述
InstanceId	String	是	实例ID。 示例值：lhins-abcd1234
Region	String	是	实例地域。 示例值：ap-guangzhou

InstancePrice

关于Lighthouse Instance实例的价格信息

被如下接口引用：InquirePriceCreateInstances, InquirePriceRenewInstances。

名称	类型	描述
OriginalBundlePrice	Float	套餐单价原价。 示例值：1.1
OriginalPrice	Float	原价。 示例值：2.2
Discount	Float	折扣。 示例值：0.8
DiscountPrice	Float	折后价。 示例值：1.8
Currency	String	价格货币单位。取值范围CNY:人民币。USD:美元。 注意：此字段可能返回 null，表示取不到有效值。 示例值：CNY

InstancePriceDetail

实例价格详细信息

被如下接口引用：InquirePriceRenewInstances。

名称	类型	描述
InstanceId	String	实例ID。 注意：此字段可能返回 null，表示取不到有效值。 示例值：lhins-xxxxxx
InstancePrice	InstancePrice	询价信息。 注意：此字段可能返回 null，表示取不到有效值。
DiscountDetail	Array of DiscountDetail	折扣梯度详情，每个梯度包含的信息有：时长，折扣数，总价，折扣价，折扣详情（用户折扣、官网折扣、最终折扣）。 注意：此字段可能返回 null，表示取不到有效值。

InstanceReturnable

实例可退还信息。

被如下接口引用：DescribeInstancesReturnable。

名称	类型	描述
InstanceId	String	实例 ID。
IsReturnable	Boolean	实例是否可退还。
ReturnFailCode	Integer	实例退还失败错误码。
ReturnFailMessage	String	实例退还失败错误信息。

InstanceTrafficPackage

实例流量包详情

被如下接口引用：DescribeInstancesTrafficPackages。

名称	类型	描述
InstanceId	String	实例ID。 示例值：lhins-abcd1234
TrafficPackageSet	Array of TrafficPackage	流量包详情列表。

InstanceViolationDetail

实例违规详情。

被如下接口引用：DescribeInstances。

名称	类型	描述
Source	String	来源：RESTRICT：封禁、FREEZW：冻结 注意：此字段可能返回 null，表示取不到有效值。
State	String	是否允许自助解封：1是，2否 注意：此字段可能返回 null，表示取不到有效值。
Reason	String	违规类型 注意：此字段可能返回 null，表示取不到有效值。
Content	String	违规内容（URL、关联域名） 注意：此字段可能返回 null，表示取不到有效值。

InternetAccessible

描述了启动配置创建实例的公网可访问性，声明了实例的公网使用计费模式，最大带宽等。

被如下接口引用：DescribeInstances。

名称	类型	描述
InternetChargeType	String	网络计费类型，取值范围： 按流量包付费：TRAFFIC_POSTPAID_BY_HOUR 按带宽付费： BANDWIDTH_POSTPAID_BY_HOUR 示例值：BANDWIDTH_PREPAID
InternetMaxBandwidthOut	Integer	公网出带宽上限，单位：Mbps。 示例值：20
PublicIpAssigned	Boolean	是否分配公网 IP。 示例值：true

KeyPair

描述密钥对信息。

被如下接口引用：CreateKeyPair, DescribeKeyPairs。

名称	类型	描述
KeyId	String	密钥对 ID ，是密钥对的唯一标识。 示例值：lhkp-omd12oc1
KeyName	String	密钥对名称。 示例值：test
PublicKey	String	密钥对的纯文本公钥。 示例值：""
AssociatedInstanceIds	Array of String	密钥对关联的实例 ID 列表。 注意：此字段可能返回 null，表示取不到有效值。 示例值：[]
CreatedTime	Timestamp ISO8601	创建时间。按照 ISO8601 标准表示，并且使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ 注意：此字段可能返回 null，表示取不到有效值。 示例值：2020-04-28T23:01:47Z
PrivateKey	String	密钥对私钥。 注意：此字段可能返回 null，表示取不到有效值。 示例值：null

LoginConfiguration

实例密码登录配置信息。

被如下接口引用：CreateInstances, ResetInstance。

名称	类型	必选	描述
AutoGeneratePassword	String	否	"YES"代表选择自动生成密码，这时不指定Password字段。 "NO"代表选择自定义密码，这时要指定Password字段。 示例值：NO
Password	String	否	实例登录密码。具体按照操作系统的复杂度要求。 LINUX_UNIX 实例密码必须 8-30 位，推荐使用 12 位以上密码，不能包含空格, 不能以“/”开头，至少包含以下字符中的三种不同字符，字符种类： 小写字母：[a-z] 大写字母：[A-Z] 数字：0-9 特殊字符： ()`~!@#$%^&*-+=_|{}[]:;' <>,.?/ WINDOWS 实例密码必须 12-30 位，不能包含空格, 不能以“/”开头且不包括用户名，至少包含以下字符中的三种不同字符 小写字母：[a-z] 大写字母：[A-Z] 数字： 0-9 特殊字符：()`~!@#$%^&*-+=_|{}[]:;' <>,.?/ 示例值： HelloTgHd123_&*
KeyIds	Array of String	否	密钥ID列表，最多同时指定5个密钥。关联密钥后，就可以通过对应的私钥来访问实例。密钥与密码不能同时指定，同时WINDOWS操作系统不支持指定密钥。密钥ID列表可以通过DescribeKeyPairs接口获取。 示例值：["lhkp-7f7lh1fv"]

LoginSettings

描述了实例登录相关配置与信息。

被如下接口引用：DescribeInstances。

名称	类型	描述
KeyIds	Array of String	密钥 ID 列表。关联密钥后，就可以通过对应的私钥来访问实例。注意：此字段可能返回 []，表示取不到有效值。 示例值：[]

ModifyBundle

描述了实例可变更的套餐。

被如下接口引用：DescribeModifyInstanceBundles。

名称	类型	描述
ModifyPrice	Price	更改实例套餐后需要补的差价。 示例值：{}
ModifyBundleState	String	变更套餐状态。取值： SOLD_OUT：套餐售罄 AVAILABLE：支持套餐变更 UNAVAILABLE：暂不支持套餐变更 示例值：AVAILABLE
Bundle	Bundle	套餐信息。 示例值：{}
NotSupportModifyMessage	String	不支持套餐变更原因信息。变更套餐状态为"AVAILABLE"时, 该信息为空 注意：此字段可能返回 null，表示取不到有效值。 示例值：""

PolicyDetail

折扣详情信息。

被如下接口引用：DescribeBundleDiscount, DescribeDiskDiscount, InquirePriceRenewInstances。

名称	类型	描述
UserDiscount	Float	用户折扣。 示例值：100
CommonDiscount	Float	公共折扣。 示例值：88
FinalDiscount	Float	最终折扣。 示例值：88
ActivityDiscount	Float	活动折扣。取值为null，表示无有效值，即没有折扣。 注意：此字段可能返回 null，表示取不到有效值。 示例值：100
DiscountType	String	折扣类型。 user：用户折扣; common：官网折扣; activity：活动折扣。 取值为null，表示无有效值，即没有折扣。 注意：此字段可能返回 null，表示取不到有效值。 示例值：common

Price

价格信息

被如下接口引用：DescribeBundles, DescribeModifyInstanceBundles, InquirePriceCreateInstances, InquirePriceRenewInstances。

名称	类型	描述
InstancePrice	InstancePrice	实例价格。

RegionInfo

描述地域信息。

被如下接口引用：DescribeRegions。

名称	类型	描述
Region	String	地域名称，例如，ap-guangzhou。 示例值：ap-beijing
RegionName	String	地域描述，例如，华南地区(广州)。 示例值：北京
RegionState	String	地域是否可用状态，取值仅为AVAILABLE。 示例值：AVAILABLE
IsChinaMainland	Boolean	是否中国大陆地域 示例值：true

RenewDiskChargePrepaid

续费云硬盘包年包月相关参数设置

被如下接口引用：InquirePriceRenewDisks, RenewDisks。

名称	类型	必选	描述
Period	Integer	否	续费周期。 示例值：1
RenewFlag	String	否	自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费，用户需要手动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不自动续费，且不通知 默认取值：NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW，在账户余额充足的情况下，云硬盘到期后将按月自动续费。 示例值：NOTIFY_AND_AUTO_RENEW
TimeUnit	String	否	周期单位。取值范围：“m”(月)。默认值: "m"。 示例值：m
CurInstanceDeadline	String	否	当前实例到期时间。如“2018-01-01 00:00:00”。指定该参数即可对齐云硬盘所挂载的实例到期时间。该参数与Period必须指定其一，且不支持同时指定。 示例值：2018-01-01 00:00:00

ResetInstanceBlueprint

描述了镜像重置信息

被如下接口引用：DescribeResetInstanceBlueprints。

名称	类型	描述
BlueprintInfo	Blueprint	镜像详细信息
IsResettable	Boolean	实例镜像是否可重置为目标镜像
NonResettableMessage	String	不可重置信息.当镜像可重置时为""

Scene

使用场景信息

被如下接口引用：DescribeScenes。

名称	类型	描述
SceneId	String	使用场景Id 示例值："lhsc-123456"
DisplayName	String	使用场景展示名称 示例值：""
Description	String	使用场景描述 示例值：""

SceneInfo

使用场景详细信息

被如下接口引用：DescribeAllScenes。

名称	类型	描述
SceneId	String	使用场景Id。 示例值："lhsc-123456"
DisplayName	String	使用场景展示名称。 示例值：""
Description	String	使用场景描述信息。 示例值：""

Snapshot

描述了快照相关信息。

被如下接口引用：DescribeSnapshots。

名称	类型	描述
SnapshotId	String	快照 ID。 示例值：lhsnap-nv6aqcv6
DiskUsage	String	创建此快照的磁盘类型。取值： SYSTEM_DISK：系统盘 示例值：SYSTEM_DISK
DiskId	String	创建此快照的磁盘 ID。 示例值：lhdisk-f71kc5bh
DiskSize	Integer	创建此快照的磁盘大小，单位 GB。 示例值：50
SnapshotName	String	快照名称，用户自定义的快照别名。 示例值：day-backup-0903145122
SnapshotState	String	快照的状态。取值范围： NORMAL：正常 CREATING：创建中 ROLLBACKING：回滚中。 示例值：NORMAL
Percent	Integer	创建或回滚快照进度百分比，成功后此字段取值为 100。 示例值：100
LatestOperation	String	快照的最新操作，只有创建、回滚快照时记录。 取值如 CreateInstanceSnapshot，RollbackInstanceSnapshot。 注意：此字段可能返回 null，表示取不到有效值。 示例值：RollbackInstanceSnapshot
LatestOperationState	String	快照的最新操作状态，只有创建、回滚快照时记录。 取值范围： SUCCESS：表示操作成功 OPERATING：表示操作执行中 FAILED：表示操作失败 注意：此字段可能返回 null，表示取不到有效值。 示例值：SUCCESS
LatestOperationRequestId	String	快照最新操作的唯一请求 ID，只有创建、回滚快照时记录。 注意：此字段可能返回 null，表示取不到有效值。 示例值：96aee6e3-172c-4f0f-be7c-fc46b9865763
CreatedTime	Timestamp ISO8601	快照的创建时间。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2020-09-03T06:51:23Z

SnapshotDeniedActions

快照操作限制列表。

被如下接口引用：DescribeSnapshotsDeniedActions。

名称	类型	描述
SnapshotId	String	快照 ID。 示例值：lhsnap-nv6aqcv6
DeniedActions	Array of DeniedAction	操作限制列表。

Software

描述镜像软件信息。

被如下接口引用：DescribeBlueprintInstances。

名称	类型	描述
Name	String	软件名称。
Version	String	软件版本。
ImageUrl	String	软件图片 URL。
InstallDir	String	软件安装目录。
DetailSet	Array of SoftwareDetail	软件详情列表。

SoftwareDetail

描述镜像软件详细信息。

被如下接口引用：DescribeBlueprintInstances。

名称	类型	描述
Key	String	详情唯一键。
Title	String	详情标题。
Value	String	详情值。

SystemDisk

描述了操作系统所在块设备即系统盘的信息。

被如下接口引用：DescribeInstances。

名称	类型	描述
DiskType	String	系统盘类型。 取值范围： LOCAL_BASIC：本地硬盘 LOCAL_SSD：本地 SSD 硬盘 CLOUD_BASIC：普通云硬盘 CLOUD_SSD：SSD 云硬盘 CLOUD_PREMIUM：高性能云硬盘 示例值：CLOUD_PREMIUM
DiskSize	Integer	系统盘大小，单位：GB。 示例值：20
DiskId	String	系统盘ID。 注意：此字段可能返回 null，表示取不到有效值。 示例值：lhdisk-jxj6qnpo

Tag

标签

被如下接口引用：CreateInstances, DescribeInstances。

名称	类型	必选	描述
Key	String	是	标签键 示例值：Owner
Value	String	是	标签值 示例值：Green

TotalPrice

总计价格信息

被如下接口引用：InquirePriceRenewInstances。

名称	类型	描述
OriginalPrice	Float	原始总计价格。 注意：此字段可能返回 null，表示取不到有效值。 示例值：10.0
DiscountPrice	Float	折扣总计价格。 注意：此字段可能返回 null，表示取不到有效值。 示例值：9.0

TrafficPackage

流量包详情

被如下接口引用：DescribeInstancesTrafficPackages。

名称	类型	描述
TrafficPackageId	String	流量包ID。 示例值：lhtfp-o1wtyyvx
TrafficUsed	Integer	流量包生效周期内已使用流量，单位字节。 示例值：5905577
TrafficPackageTotal	Integer	流量包生效周期内的总流量，单位字节。 示例值：536870912000
TrafficPackageRemaining	Integer	流量包生效周期内的剩余流量，单位字节。 示例值：536865006423
TrafficOverflow	Integer	流量包生效周期内超出流量包额度的流量，单位字节。 示例值：0
StartTime	Timestamp ISO8601	流量包生效周期开始时间。按照 ISO8601 标准表示，并且使用 UTC 时间。 格式为： YYYY-MM-DDThh:mm:ssZ。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2020-06-28T08:15:18Z
EndTime	Timestamp ISO8601	流量包生效周期结束时间。按照 ISO8601 标准表示，并且使用 UTC 时间。 格式为： YYYY-MM-DDThh:mm:ssZ。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2020-07-28T08:15:17Z
Deadline	Timestamp ISO8601	流量包到期时间。按照 ISO8601 标准表示，并且使用 UTC 时间。 格式为： YYYY-MM-DDThh:mm:ssZ。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2020-07-28T08:15:18Z
Status	String	流量包状态： NETWORK_NORMAL：正常 OVERDUE_NETWORK_DISABLED：欠费断网 示例值：NETWORK_NORMAL

ZoneInfo

可用区详细信息

被如下接口引用：DescribeZones。

名称	类型	描述
Zone	String	可用区 示例值：ap-guangzhou-1
ZoneName	String	可用区中文名称 示例值：广州一区
InstanceDisplayLabel	String	实例购买页可用区展示标签 示例值：NORMAL