tencent cloud

$0 14-Day TrialExperience EdgeOne for acceleration and security protection!

Feedback

Edge Computing Machine

Data Types

Last updated: 2024-11-27 16:20:18

Address

EIP information

Used by actions: DescribeAddresses.

Name Type Description
AddressId String Unique EIP ID.
AddressName String EIP name.
AddressStatus String EIP status, including 'CREATING' (creating), 'BINDING' (binding), 'BIND' (bound), 'UNBINDING' (unbinding), 'UNBIND' (unbound), 'OFFLINING' (releasing), and 'BIND_ENI' (binding dangling ENI)
AddressIp String Public IP address
InstanceId String ID of the bound resource instance.
Note: this field may return null, indicating that no valid values can be obtained.
CreatedTime String Creation time in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.sssZ)
NetworkInterfaceId String ID of the bound ENI
Note: this field may return null, indicating that no valid values can be obtained.
PrivateAddressIp String Private IP of the bound resource
Note: this field may return null, indicating that no valid values can be obtained.
IsArrears Boolean Isolation status of the resource. true: isolated; false: not isolated.
IsBlocked Boolean Blockage status of the EIP resource. true: blocked; false: not blocked
IsEipDirectConnection Boolean Whether the EIP supports direct access mode. true: yes; false: no.
AddressType String Resource type of the EIP, including CalcIP (device IP), WanIP (general public IP), EIP (elastic IP), and AnycastEip (accelerated EIP).
CascadeRelease Boolean Whether the EIP is automatically released after being unbound. true: yes; false: no
InternetServiceProvider String ISP. CTCC: China Telecom; CUCC: China Unicom; CMCC: China Mobile
Note: this field may return null, indicating that no valid values can be obtained.
Bandwidth Integer Bandwidth cap
Note: this field may return null, indicating that no valid values can be obtained.
PayMode String Billing mode
Note: this field may return null, indicating that no valid values can be obtained.

AddressInfo

IP address information structure.

Used by actions: DescribeInstances.

Name Type Description
PublicIPAddressInfo PublicIPAddressInfo Public IP information of the instance.
Note: this field may return null, indicating that no valid values can be obtained.
PrivateIPAddressInfo PrivateIPAddressInfo Private IP information of the instance.
Note: this field may return null, indicating that no valid values can be obtained.
PublicIPv6AddressInfo PublicIPAddressInfo Public IPv6 information of the instance.
Note: this field may return null, indicating that no valid values can be obtained.

AddressTemplateSpecification

IP address template

Used by actions: CreateSecurityGroupPolicies, DeleteSecurityGroupPolicies, DescribeSecurityGroupPolicies, ModifySecurityGroupPolicies, ReplaceSecurityGroupPolicy.

Name Type Required Description
AddressId String Yes IP address ID, such as eipm-2uw6ujo6.
AddressGroupId String Yes IP address group ID, such as eipmg-2uw6ujo6.

Area

Region information

Used by actions: DescribeInstances, DescribeLoadBalancers, DescribeNode.

Name Type Description
AreaId String Region ID
AreaName String Region name

AssistantCidr

Secondary CIDR information of the VPC.

Used by actions: CreateVpc, DescribeVpcs.

Name Type Description
VpcId String VPC instance ID, such as vpc-6v2ht8q5
CidrBlock String Secondary CIDR, such as 172.16.0.0/16
AssistantType Integer Secondary CIDR block type. 0: general secondary CIDR block; 1: container secondary CIDR block. Default value: 0.
SubnetSet Array of Subnet Subnets divided by the secondary CIDR block.
Note: this field may return null, indicating that no valid values can be obtained.
Note: this field may return null, indicating that no valid values can be obtained.

Backend

CLB backend information

Used by actions: DescribeTargets.

Name Type Description
InstanceId String Unique real server ID
Note: this field may return null, indicating that no valid values can be obtained.
Port Integer Listening port of the real server
Note: this field may return null, indicating that no valid values can be obtained.
Weight Integer Forwarding weight of the real server. Value range: [0, 100]. Default value: 10.
Note: this field may return null, indicating that no valid values can be obtained.
PrivateIpAddresses Array of String Private IP of the real server
Note: this field may return null, indicating that no valid values can be obtained.
RegisteredTime Timestamp Real server binding time
Note: this field may return null, indicating that no valid values can be obtained.
EniId String Unique ENI ID
Note: this field may return null, indicating that no valid values can be obtained.
PublicIpAddresses Array of String Public IP of the real server
Note: this field may return null, indicating that no valid values can be obtained.
InstanceName String Real server instance name
Note: this field may return null, indicating that no valid values can be obtained.

BatchTarget

CLB batch targets

Used by actions: BatchDeregisterTargets, BatchRegisterTargets.

Name Type Required Description
ListenerId String No Listener ID
Note: this field may return null, indicating that no valid values can be obtained.
Port Integer No Bound port
Note: this field may return null, indicating that no valid values can be obtained.
InstanceId String No CVM instance ID
Note: this field may return null, indicating that no valid values can be obtained.
EniIp String No ENI IP
Note: this field may return null, indicating that no valid values can be obtained.
Weight Integer No Weight of the CVM instance. Value range: [0, 100]. If it is not specified for binding the instance, 10 will be used by default.
Note: this field may return null, indicating that no valid values can be obtained.

City

City information

Used by actions: DescribeInstances, DescribeLoadBalancers, DescribeNode.

Name Type Description
CityId String City ID
CityName String City name

Country

Country/Region information

Used by actions: DescribeInstances, DescribeLoadBalancers, DescribeNode.

Name Type Description
CountryId String Country/Region ID
CountryName String Country/Region name

DataDisk

Data disk information

Used by actions: CreateModule, DescribeModuleDetail, DescribePriceRunInstance, ModifyModuleConfig, RunInstances.

Name Type Required Description
DiskSize Integer Yes Data disk size in GB.
DiskType String No Data disk type. Valid values:
- LOCAL_BASIC: local disk
- CLOUD_PREMIUM: Premium Cloud Storage

Default value: LOCAL_BASIC.

DiskInfo

Disk information

Used by actions: DescribeInstances.

Name Type Description
DiskType String Disk type: LOCAL_BASIC.
DiskId String Disk ID
DiskSize Integer Disk size in GB

EipQuota

EIP quota information

Used by actions: DescribeAddressQuota.

Name Type Description
QuotaId String Quota name. Valid values:
TOTAL_EIP_QUOTA: quota of EIPs in the current region;
DAILY_EIP_APPLY: today's number of applications in the current region;
DAILY_PUBLIC_IP_ASSIGN: number of public IP reassignments in the current region.
QuotaCurrent Integer Current quantity
QuotaLimit Integer Quota

EnhancedService

Enhanced service

Used by actions: ResetInstances, RunInstances.

Name Type Required Description
SecurityService RunSecurityServiceEnabled No Whether to enable CWP.
MonitorService RunMonitorServiceEnabled No Whether to enable CM.
EIPDirectService RunEIPDirectServiceEnabled No Whether to enable IP direct access. If this parameter is not specified, IP direct access will be enabled by default for Linux images and is currently not supported for Windows images.

Filter

Key-Value pair filter for conditional filtering queries.

Used by actions: DescribeAddresses, DescribeCustomImageTask, DescribeHaVips, DescribeImage, DescribeInstances, DescribeLoadBalancers, DescribeModule, DescribeMonthPeakNetwork, DescribeNetworkInterfaces, DescribeNode, DescribePackingQuotaGroup, DescribePeakNetworkOverview, DescribeRouteTables, DescribeSecurityGroups, DescribeSnapshots, DescribeSubnets, DescribeVpcs.

Name Type Required Description
Values Array of String Yes One or more filter values.
Name String Yes Filter name.

HaVip

HAVIP object.

Used by actions: CreateHaVip, DescribeHaVips.

Name Type Description
HaVipId String Unique HAVIP ID.
HaVipName String HAVIP name.
Vip String Virtual IP address.
VpcId String VPC ID of the HAVIP.
SubnetId String Subnet ID of the HAVIP.
NetworkInterfaceId String ID of the ENI associated with the HAVIP.
InstanceId String ID of the bound instance.
AddressIp String Bound EIP.
State String Status:
AVAILABLE: running.
UNBIND: unbound.
CreatedTime String Creation time.
Business String ID of businesses that use HAVIP.

HealthCheck

CLB health check

Used by actions: CreateListener, DescribeListeners, ModifyListener.

Name Type Required Description
HealthSwitch Integer No Whether to enable health check. Valid values: 1: enable; 0: disable
Note: this field may return null, indicating that no valid values can be obtained.
TimeOut Integer No Health check response timeout period in seconds. Value range: 2–60. Default value: 2. The value of this parameter should be smaller than the check interval.
Note: this field may return null, indicating that no valid values can be obtained.
IntervalTime Integer No Health check interval in seconds. Value range: 5–300. Default value: 5.
Note: this field may return null, indicating that no valid values can be obtained.
HealthNum Integer No Health threshold. Value range: 2–10. Default value: 3, indicating that if a forward is found healthy three consecutive times, it will be considered normal.
Note: this field may return null, indicating that no valid values can be obtained.
UnHealthyNum Integer No Unhealthy threshold. Value range: 2–10. Default value: 3, indicating that if a forward is found unhealthy three consecutive times, it will be considered exceptional.
Note: this field may return null, indicating that no valid values can be obtained.
CheckPort Integer No Health check port (a custom check parameter), which is the port of the real server by default. Unless you want to specify a port, we recommend you leave it empty.
Note: this field may return null, indicating that no valid values can be obtained.
ContextType String No Health check protocol (a custom check parameter), which is required if the value of CheckType is CUSTOM. This parameter represents the input format of the health check. Valid values: HEX, TEXT. If the value is HEX, the characters of SendContext and RecvContext can only be selected from 0123456789ABCDEF, and the length must be an even number.
Note: this field may return null, indicating that no valid values can be obtained.
SendContext String No Health check protocol (a custom check parameter), which is required if the value of CheckType is CUSTOM. This parameter represents the content of the request sent by the health check. It can contain up to 500 visible ASCII characters.
Note: this field may return null, indicating that no valid values can be obtained.
RecvContext String No Health check protocol (a custom check parameter), which is required if the value of CheckType is CUSTOM. This parameter represents the result returned by the health check. It can contain up to 500 visible ASCII characters.
Note: this field may return null, indicating that no valid values can be obtained.
CheckType String No Health check protocol (a custom check parameter). Valid values: TCP, CUSTOM (applicable only to UDP listeners. If custom health check is used, this parameter will be required).
Note: this field may return null, indicating that no valid values can be obtained.

ISP

ISP information

Used by actions: DescribeInstances, DescribeNode.

Name Type Description
ISPId String ISP ID
ISPName String ISP name

ISPCounter

ISP statistics

Used by actions: DescribeModuleDetail.

Name Type Description
ProviderName String ISP name
ProviderNodeNum Integer Number of nodes
ProvederInstanceNum Integer Number of instances
ZoneInstanceInfoSet Array of ZoneInstanceInfo Zone instance information structure array

Image

Image information

Used by actions: DescribeImage, DescribeInstances, DescribeModuleDetail, DescribeSnapshots.

Name Type Description
ImageId String Image ID
ImageName String Image name
ImageState String Image status
ImageType String Image type
ImageOsName String OS name
ImageDescription String Image description
ImageCreateTime String Image import time
Architecture String Number of bits of the OS
OsType String OS type
OsVersion String OS version
Platform String OS platform
ImageOwner Integer Image owner
ImageSize Integer Image size in GB
SrcImage SrcImage Image source information
ImageSource String Image source type
TaskId String ID of the task in intermediate or failed status
IsSupportCloudInit Boolean Whether cloud-init is supported

ImageLimitConfig

Image size configuration

Used by actions: DescribeConfig.

Name Type Description
MaxImageSize Integer Supported maximum image size in GB, including custom image size for import and central cloud image size.

ImageOsList

Supported OS type. Valid values: Windows, Linux.

Used by actions: DescribeImportImageOs.

Name Type Description
Windows Array of String Supported Windows OS
Note: this field may return null, indicating that no valid values can be obtained.
Linux Array of String Supported Linux OS
Note: this field may return null, indicating that no valid values can be obtained.

ImageTask

Image task

Used by actions: DescribeCustomImageTask.

Name Type Description
State String Image import status. Valid values: PENDING, PROCESSING, SUCCESS, FAILED
Message String Cause of import failure (FAILED)
Note: this field may return null, indicating that no valid values can be obtained.
ImageName String Image name
CreateTime String Creation time

Instance

Instance information.

Used by actions: DescribeInstances.

Name Type Description
InstanceId String Instance ID.
InstanceName String Instance name, such as ens-34241f3s.
Note: this field may return null, indicating that no valid values can be obtained.
InstanceState String Instance status. Valid values:
PENDING: creating
LAUNCH_FAILED: failed to create
RUNNING: running
STOPPED: shut down
STARTING: starting
STOPPING: shutting down
REBOOTING: restarting
SHUTDOWN: to be terminated
TERMINATING: terminating.
Image Image Information of the image currently used by the instance.
Note: this field may return null, indicating that no valid values can be obtained.
SimpleModule SimpleModule Basic information of the current module of the instance.
Note: this field may return null, indicating that no valid values can be obtained.
Position Position Location information of the instance.
Note: this field may return null, indicating that no valid values can be obtained.
Internet Internet Network information of the instance.
Note: this field may return null, indicating that no valid values can be obtained.
InstanceTypeConfig InstanceTypeConfig Configuration information of the instance.
Note: this field may return null, indicating that no valid values can be obtained.
CreateTime String Instance creation time.
Note: this field may return null, indicating that no valid values can be obtained.
TagSet Array of Tag Instance tag information.
Note: this field may return null, indicating that no valid values can be obtained.
LatestOperation String Last operation on the instance.
Note: this field may return null, indicating that no valid values can be obtained.
LatestOperationState String Result of the last operation on the instance.
Note: this field may return null, indicating that no valid values can be obtained.
RestrictState String Instance business status. Valid values:
NORMAL: normal
EXPIRED: expired
PROTECTIVELY_ISOLATED: isolated.
Note: this field may return null, indicating that no valid values can be obtained.
SystemDiskSize Integer System disk size in GB.
Note: this field may return null, indicating that no valid values can be obtained.
DataDiskSize Integer Data disk size in GB.
Note: this field may return null, indicating that no valid values can be obtained.
UUID String Instance UUID
Note: this field may return null, indicating that no valid values can be obtained.
PayMode Integer Billing mode.
0: postpaid.
1: prepaid.
Note: this field may return null, indicating that no valid values can be obtained.
ExpireTime String Expiration time in the format of yyyy-mm-dd HH:mm:ss.
Note: this field may return null, indicating that no valid values can be obtained.
IsolatedTime String Isolation time in the format of yyyy-mm-dd HH:mm:ss.
Note: this field may return null, indicating that no valid values can be obtained.
RenewFlag Integer Auto-Renewal flag.
0: no.
1: yes.
Note: this field may return null, indicating that no valid values can be obtained.
ExpireState String Expiration status.
NORMAL: normal.
WILL_EXPIRE: about to expire.
EXPIRED: expired.
Note: this field may return null, indicating that no valid values can be obtained.
SystemDisk DiskInfo System disk information
Note: this field may return null, indicating that no valid values can be obtained.
DataDisks Array of DiskInfo Data disk information
Note: this field may return null, indicating that no valid values can be obtained.
NewFlag Integer New instance flag
Note: this field may return null, indicating that no valid values can be obtained.
SecurityGroupIds Array of String Security group of the instance, which can be obtained from the sgId field in the returned value of the DescribeSecurityGroups API.
Note: this field may return null, indicating that no valid values can be obtained.
VirtualPrivateCloud VirtualPrivateCloud VPC attribute
Note: this field may return null, indicating that no valid values can be obtained.
ISP String ISP field of the instance.
Note: this field may return null, indicating that no valid values can be obtained.
PhysicalPosition PhysicalPosition Physical location information. Note that this field is currently a reserved field and null.
Note: this field may return null, indicating that no valid values can be obtained.

InstanceFamilyConfig

Model family configuration

Used by actions: DescribeInstanceTypeConfig, DescribeInstances, DescribeModuleDetail.

Name Type Description
InstanceFamilyName String Model name
InstanceFamily String Model ID

InstanceFamilyTypeConfig

Instance family type configuration

Used by actions: DescribeInstanceTypeConfig, DescribeInstances, DescribeModuleDetail, DescribePeakBaseOverview.

Name Type Description
InstanceFamilyType String Instance model family type ID
InstanceFamilyTypeName String Instance model family type name

InstanceNetworkInfo

Instance ENI IP information array

Used by actions: DescribeInstances.

Name Type Description
AddressInfoSet Array of AddressInfo Private and public IP information of the instance.
Note: this field may return null, indicating that no valid values can be obtained.
NetworkInterfaceId String ENI ID.
NetworkInterfaceName String ENI name.
Note: this field may return null, indicating that no valid values can be obtained.
Primary Boolean Primary ENI attribute. Valid values: true: primary ENI; false: secondary ENI.

InstanceNetworkLimitConfig

Network resource limit of the instance

Used by actions: DescribeConfig.

Name Type Description
CpuNum Integer Number of CPU cores
NetworkInterfaceLimit Integer ENI quantity limit
InnerIpPerNetworkInterface Integer Private IP quantity limit per ENI
PublicIpPerInstance Integer Public IP limit per instance

InstanceOperator

Executable operations for the instance

Used by actions: DescribeInstancesDeniedActions.

Name Type Description
InstanceId String Instance ID
DeniedActions Array of OperatorAction Prohibited operations for the instance
Note: this field may return null, indicating that no valid values can be obtained.

InstancePricesPartDetail

Instance price information

Used by actions: DescribePriceRunInstance.

Name Type Required Description
CpuPrice PriceDetail Yes CPU price information
MemPrice PriceDetail Yes Memory price information
DisksPrice PriceDetail Yes Disk price information

InstanceStatistic

Instance statistics

Used by actions: DescribeSecurityGroupAssociationStatistics.

Name Type Description
InstanceType String Instance type
InstanceCount Integer Number of instances

InstanceTypeConfig

Model configuration

Used by actions: DescribeInstanceTypeConfig, DescribeInstances, DescribeModuleDetail.

Name Type Description
InstanceFamilyConfig InstanceFamilyConfig Model family configuration information
InstanceType String Model
Vcpu Integer Number of CPU cores
Memory Integer Memory size
Frequency String Clock rate
CpuModelName String CPU model
InstanceFamilyTypeConfig InstanceFamilyTypeConfig Instance family type configuration information
ExtInfo String Extra model information, which is a JSON string in the format of {"dataDiskSize":3200,"systemDiskSize":60, "systemDiskSizeShow":"default system disk size:60 GB","dataDiskSizeShow":"local NVMe SSD: 3200 GB"}. It indicates a special model if it exists
Note: this field may return null, indicating that no valid values can be obtained.
Vgpu Float Number of GPU cards
Note: this field may return null, indicating that no valid values can be obtained.
GpuModelName String GPU model
Note: this field may return null, indicating that no valid values can be obtained.

InstancesPrice

Instance price information

Used by actions: DescribePriceRunInstance.

Name Type Required Description
InstancePricesPartDetail InstancePricesPartDetail Yes Instance price details
Discount Integer Yes Discount on the total instance price
DiscountPrice Integer Yes Discounted price
OriginalPrice Integer Yes Original cost

Internet

Network information of the instance.

Used by actions: DescribeInstances.

Name Type Description
PrivateIPAddressSet Array of PrivateIPAddressInfo Private network information list of the instance, with the primary ENI followed by secondary ENIs in the order of binding.
Note: this field may return null, indicating that no valid values can be obtained.
PublicIPAddressSet Array of PublicIPAddressInfo Public network information list of the instance, with the primary ENI followed by secondary ENIs in the order of binding.
Note: this field may return null, indicating that no valid values can be obtained.
InstanceNetworkInfoSet Array of InstanceNetworkInfo Network information of the instance.
Note: this field may return null, indicating that no valid values can be obtained.

Ipv6Address

IPv6 address information.

Used by actions: AssignIpv6Addresses, CreateNetworkInterface, DescribeNetworkInterfaces, ModifyIpv6AddressesAttribute, ReleaseIpv6Addresses.

Name Type Required Description
Address String Yes IPv6 address, such as 3402:4e00:20:100:0:8cd9:2a67:71f3
Primary Boolean No Whether it is the primary IP.
AddressId String No EIP instance ID, such as eip-hxlqja90.
Description String No Description.
IsWanIpBlocked Boolean No Whether the public IP is blocked.
State String No IPv6 address status:
PENDING: generating
MIGRATING: migrating
DELETING: deleting
AVAILABLE: available

KeyPair

Key pair information

Used by actions: CreateKeyPair.

Name Type Description
KeyId String Key pair ID, which is the unique identifier of a key pair.
Note: this field may return null, indicating that no valid values can be obtained.
KeyName String Key pair name.
Note: this field may return null, indicating that no valid values can be obtained.
ProjectId Integer Project ID of the key pair.
Note: this field may return null, indicating that no valid values can be obtained.
Description String Key pair description.
Note: this field may return null, indicating that no valid values can be obtained.
PublicKey String Public key (in plain text) of key pair.
Note: this field may return null, indicating that no valid values can be obtained.
PrivateKey String Private key (in plaintext) of a key pair. Tencent Cloud do not store private keys. Therefore, keep them secure.
Note: this field may return null, indicating that no valid values can be obtained.
AssociatedInstanceIds Array of String List of IDs of the instances associated with the key.
Note: this field may return null, indicating that no valid values can be obtained.
CreatedTime Timestamp ISO8601 Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used.
Note: this field may return null, indicating that no valid values can be obtained.

Listener

CLB listener

Used by actions: DescribeListeners.

Name Type Description
ListenerId String CLB listener ID
Note: this field may return null, indicating that no valid values can be obtained.
Protocol String Listener protocol
Note: this field may return null, indicating that no valid values can be obtained.
Port Integer Listener port.
Note: this field may return null, indicating that no valid values can be obtained.
HealthCheck HealthCheck Health check information of the listener
Note: this field may return null, indicating that no valid values can be obtained.
Scheduler String Request scheduling method
Note: this field may return null, indicating that no valid values can be obtained.
SessionExpireTime Integer Session persistence time
Note: this field may return null, indicating that no valid values can be obtained.
ListenerName String Listener name
Note: this field may return null, indicating that no valid values can be obtained.
CreateTime String Listener creation time
Note: this field may return null, indicating that no valid values can be obtained.
SessionType String Session type of the listener
Note: this field may return null, indicating that no valid values can be obtained.
EndPort Integer End port of the port range
Note: this field may return null, indicating that no valid values can be obtained.

ListenerBackend

Listener backend

Used by actions: DescribeTargets.

Name Type Description
ListenerId String Listener ID
Note: this field may return null, indicating that no valid values can be obtained.
Protocol String Listener protocol
Note: this field may return null, indicating that no valid values can be obtained.
Port Integer Listener port
Note: this field may return null, indicating that no valid values can be obtained.
Targets Array of Backend List of real servers bound to the CLB instance
Note: this field may return null, indicating that no valid values can be obtained.

ListenerHealth

Listener health status

Used by actions: DescribeTargetHealth.

Name Type Description
ListenerId String Listener ID
Note: this field may return null, indicating that no valid values can be obtained.
ListenerName String Listener name
Note: this field may return null, indicating that no valid values can be obtained.
Protocol String Listener protocol
Note: this field may return null, indicating that no valid values can be obtained.
Port Integer Listener port
Note: this field may return null, indicating that no valid values can be obtained.
Rules Array of RuleHealth List of forwarding rules of the listener
Note: this field may return null, indicating that no valid values can be obtained.

LoadBalancer

CLB instance information

Used by actions: DescribeLoadBalancers.

Name Type Description
Region String Region.
Note: this field may return null, indicating that no valid values can be obtained.
Position Position Location information.
Note: this field may return null, indicating that no valid values can be obtained.
LoadBalancerId String CLB instance ID.
Note: this field may return null, indicating that no valid values can be obtained.
LoadBalancerName String CLB instance name.
Note: this field may return null, indicating that no valid values can be obtained.
LoadBalancerType String Network type of the CLB instance. Valid values: OPEN: public network
Note: this field may return null, indicating that no valid values can be obtained.
LoadBalancerVips Array of String List of VIPs of the CLB instance.
Note: this field may return null, indicating that no valid values can be obtained.
Status Integer CLB instance status. Valid values:
0: creating; 1: running.
Note: this field may return null, indicating that no valid values can be obtained.
CreateTime Timestamp CLB instance creation time.
Note: this field may return null, indicating that no valid values can be obtained.
StatusTime Timestamp Last status change time of the CLB instance.
Note: this field may return null, indicating that no valid values can be obtained.
VpcId String VPC ID.
Note: this field may return null, indicating that no valid values can be obtained.
Tags Array of TagInfo CLB instance tag information.
Note: this field may return null, indicating that no valid values can be obtained.
VipIsp String ISP of the CLB IP address.
Note: this field may return null, indicating that no valid values can be obtained.
NetworkAttributes LoadBalancerInternetAccessible Network attribute of the CLB instance.
Note: this field may return null, indicating that no valid values can be obtained.
SecureGroups Array of String Security group.
Note: this field may return null, indicating that no valid values can be obtained.
LoadBalancerPassToTarget Boolean Whether the real server opens the traffic from ELB to the internet.
Note: this field may return null, indicating that no valid values can be obtained.
AddressIPv6 String IPv6 address of a CLB instance
Note: This field may return null, indicating that no valid values can be obtained.

LoadBalancerHealth

CLB health status

Used by actions: DescribeTargetHealth.

Name Type Description
LoadBalancerId String CLB instance ID
Note: this field may return null, indicating that no valid values can be obtained.
LoadBalancerName String CLB instance name
Note: this field may return null, indicating that no valid values can be obtained.
Listeners Array of ListenerHealth List of listeners
Note: this field may return null, indicating that no valid values can be obtained.

LoadBalancerInternetAccessible

CLB information such as bandwidth limit.

Used by actions: CreateLoadBalancer, DescribeLoadBalancers, ModifyLoadBalancerAttributes.

Name Type Required Description
InternetMaxBandwidthOut Integer No Maximum outbound bandwidth in Mbps. Default value: 10.

Module

Module information

Used by actions: DescribeModule, DescribeModuleDetail.

Name Type Description
ModuleId String Module ID.
ModuleName String Module name.
ModuleState String Module status. Valid values:
NORMAL: normal.
DELETING: deleting
DELETEFAILED: failed to delete.
DefaultSystemDiskSize Integer Default system disk size.
DefaultDataDiskSize Integer Default data disk size.
InstanceTypeConfig InstanceTypeConfig Default model.
DefaultImage Image Default image.
CreateTime String Creation time.
DefaultBandwidth Integer Default outbound bandwidth.
TagSet Array of Tag Tag set.
Note: this field may return null, indicating that no valid values can be obtained.
CloseIpDirect Integer Whether to disable IP direct access.
SecurityGroupIds Array of String List of default security group IDs.
DefaultBandwidthIn Integer Default inbound bandwidth.
UserData String Custom script data
SystemDisk SystemDisk System disk information.
DataDisks Array of DataDisk Data disk information.

ModuleCounter

Node statistics

Used by actions: DescribeModuleDetail.

Name Type Description
ISPCounterSet Array of ISPCounter ISP statistics list
ProvinceNum Integer Number of provinces/states
CityNum Integer Number of cities
NodeNum Integer Number of nodes
InstanceNum Integer Number of instances

ModuleItem

Item information of the module list

Used by actions: DescribeModule.

Name Type Description
NodeInstanceNum NodeInstanceNum Instance statistics of the node
Module Module Module information

MonthNetwork

Bandwidth information of the corresponding month

Used by actions: DescribeMonthPeakNetwork.

Name Type Description
ZoneInfo ZoneInfo Zone information of the node
Month String Bandwidth month, such as 202103
BandwidthPkgId String Bandwidth package ID format, such as bwp-xxxxxxxx
Isp String ISP abbreviation. Valid values: CUCC, CTCC, CMCC
TrafficMaxIn Float Inbound bandwidth package peak. Value range: 0.0–xxx.xxx
TrafficMaxOut Float Outbound bandwidth package peak. Value range: 0.0–xxx.xxx
FeeTraffic Float Billable bandwidth. Value range: 0.0–xxx.xxx
StartTime String Start time of the monthly billable bandwidth in the format of yyyy-mm-dd HH:mm:ss
EndTime String End time of the monthly billable bandwidth in the format of yyyy-mm-dd HH:mm:ss
EffectiveDays Integer Number of actual valid days for the monthly billable bandwidth, which must be an integer greater than or equal to 0
MonthDays Integer Actual number of days in the specified month, such as 30
EffectiveDaysRate Float Proportion of the number of valid days, accurate to four decimal places, such as 0.2134
BandwidthPkgType String Billable bandwidth package type. Valid values: Address, LoadBalance, AddressIpv6

NetworkInterface

ENI

Used by actions: CreateNetworkInterface, DescribeNetworkInterfaces.

Name Type Description
NetworkInterfaceId String ENI instance ID, such as eni-f1xjkw1b.
NetworkInterfaceName String ENI name.
NetworkInterfaceDescription String ENI description.
SubnetId String Subnet instance ID.
VpcId String VPC instance ID.
GroupSet Array of String Bound security groups.
Note: this field may return null, indicating that no valid values can be obtained.
Primary Boolean Whether it is the primary ENI.
MacAddress String MAC address.
State String ENI status:
PENDING: creating
AVAILABLE: available
ATTACHING: binding
DETACHING: unbinding
DELETING: deleting
PrivateIpAddressSet Array of PrivateIpAddressSpecification Private IP information.
Note: this field may return null, indicating that no valid values can be obtained.
Attachment NetworkInterfaceAttachment Bound CVM object.
Note: this field may return null, indicating that no valid values can be obtained.
Note: this field may return null, indicating that no valid values can be obtained.
Zone String AZ.
CreatedTime String Creation time.
Ipv6AddressSet Array of Ipv6Address List of IPv6 addresses.
Note: this field may return null, indicating that no valid values can be obtained.
TagSet Array of Tag Tag key-value pairs.
Note: this field may return null, indicating that no valid values can be obtained.
EniType Integer ENI type. Valid values: 0: ENI; 1: EVM ENI.
EcmRegion String ECM region (EcmRegion)
Business String Type of the resource bound with an ENI. Valid values: cvm and eks.
Note: This field may return null, indicating that no valid values can be obtained.

NetworkInterfaceAttachment

Binding relationship of the ENI

Used by actions: CreateNetworkInterface, DescribeNetworkInterfaces.

Name Type Description
InstanceId String CVM instance ID.
DeviceIndex Integer Serial number of the ENI in the CVM instance.
InstanceAccountId String Account information of the CVM instance owner.
AttachTime String Binding time.

NetworkStorageRange

Upper and lower limits of the disk

Used by actions: DescribeConfig.

Name Type Description
MaxBandwidth Integer Network bandwidth cap
MaxSystemDiskSize Integer Upper limit of the data disk size
MinBandwidth Integer Lower limit of the network bandwidth
MinSystemDiskSize Integer Lower limit of the data disk size
MaxDataDiskSize Integer Maximum data disk size
MinDataDiskSize Integer Minimum data disk size
SuggestBandwidth Integer Suggested bandwidth
SuggestDataDiskSize Integer Suggested disk size
SuggestSystemDiskSize Integer Suggested system disk size
MaxVcpu Integer Peak number of CPU cores
MinVcpu Integer Minimum number of CPU cores
MaxVcpuPerReq Integer Maximum number of CPU cores per request
PerBandwidth Integer Bandwidth increment
PerDataDisk Integer Data disk increment
MaxModuleNum Integer Total number of modules

Node

Node information

Used by actions: DescribeNode.

Name Type Description
ZoneInfo ZoneInfo Zone information.
Country Country Country/Region information.
Area Area Region information.
Province Province Province/State information.
City City City information.
RegionInfo RegionInfo Region information.
ISPSet Array of ISP List of ISPs.
ISPNum Integer Number of ISPs.

NodeInstanceNum

Instance number of the node

Used by actions: DescribeModule.

Name Type Description
NodeNum Integer Number of nodes
InstanceNum Integer Number of instances

OperatorAction

Operation (action)

Used by actions: DescribeInstancesDeniedActions.

Name Type Description
Action String Executable operation
Code String Code
Note: this field may return null, indicating that no valid values can be obtained.
Message String Specific information
Note: this field may return null, indicating that no valid values can be obtained.

OsVersion

Supported OS types.

Used by actions: DescribeImportImageOs.

Name Type Description
OsName String OS type
OsVersions Array of String Supported OS versions
Note: this field may return null, indicating that no valid values can be obtained.
Architecture Array of String Supported OS architecture
Note: this field may return null, indicating that no valid values can be obtained.

PackingQuotaGroup

A set of correlated packing quotas sorted by instance type priority

Used by actions: DescribePackingQuotaGroup.

Name Type Description
Zone String AZ
ZoneId Integer AZ ID
ISPId String ISP id
PackingQuotaInfos Array of PackingQuotaInfo A set of correlated packing quotas

PackingQuotaInfo

The information of a set of correlated packing quotas

Used by actions: DescribePackingQuotaGroup.

Name Type Description
InstanceType String Instance type
PackingQuota Integer Packing quota

PeakBase

Peak information

Used by actions: DescribePeakBaseOverview.

Name Type Description
PeakCpuNum Integer Peak CPU
PeakMemoryNum Integer Peak memory
PeakStorageNum Integer Peak disk
RecordTime String Recording time

PeakFamilyInfo

PeakFamilyInfo: peak information of data such as CPU by model type

Used by actions: DescribePeakBaseOverview.

Name Type Description
InstanceFamily InstanceFamilyTypeConfig Model type information.
PeakBaseSet Array of PeakBase Peak information of basic data.

PeakNetwork

Peak network data

Used by actions: DescribePeakNetworkOverview.

Name Type Description
RecordTime String Recording time.
PeakInNetwork String Inbound bandwidth data.
PeakOutNetwork String Outbound bandwidth data.
ChargeNetwork String Billable bandwidth in bps

PeakNetworkRegionInfo

Peak network information by region

Used by actions: DescribePeakNetworkOverview.

Name Type Description
Region String Region information
PeakNetworkSet Array of PeakNetwork Peak network set
Note: this field may return null, indicating that no valid values can be obtained.

PhysicalPosition

Physical location information

Used by actions: DescribeInstances.

Name Type Description
PosId String Rack unit
Note: this field may return null, indicating that no valid values can be obtained.
RackId String Rack
Note: this field may return null, indicating that no valid values can be obtained.
SwitchId String Switch
Note: this field may return null, indicating that no valid values can be obtained.

Placement

Abstract location of the instance, including its AZ, project, and dedicated cluster ID and name.

Used by actions: DescribeSnapshots.

Name Type Required Description
Zone String Yes AZ ID of the cloud disk, which can be obtained from the Zone field in the returned value of the DescribeZones API.
CageId String No Cage ID. When it is used as an input parameter, it indicates to manipulate the resources in the cage with the specified CageId and can be left empty. When it is used as an output parameter, it represents the cage ID of the resource and can be left empty.
Note: this field may return null, indicating that no valid values can be obtained.
ProjectId Integer No Project ID of the instance, which can be obtained from the projectId field in the returned value of the DescribeProject API. If this parameter is not specified, the default project ID will be used.
CdcName String No Name of the dedicated cluster. When it is used as an input parameter, it is ignored. When it is used as an output parameter, it represents the name of the dedicated cluster to which the cloud disk belongs, and it can be left empty.
Note: this field may return null, indicating that no valid values can be obtained.
CdcId String No Dedicated cluster ID of the instance. When it is used as an input parameter, it indicates to manipulate the resources in the dedicated cluster with the specified CdcId and can be left empty. When it is used as an output parameter, it represents the dedicated cluster ID of the resource and can be left empty.
Note: this field may return null, indicating that no valid values can be obtained.

Position

Location information of the instance.

Used by actions: DescribeInstances, DescribeLoadBalancers.

Name Type Description
ZoneInfo ZoneInfo Zone information of the instance.
Country Country Country/Region information of the instance.
Area Area Area information of the instance.
Province Province Province/State information of the instance.
City City City information of the instance.
RegionInfo RegionInfo Region information of the instance.

PriceDetail

Prices of CPU, memory, and other resources

Used by actions: DescribePriceRunInstance.

Name Type Required Description
Discount Integer Yes Discount, such as 20, which represents 80% off
DiscountPrice Integer Yes Discounted price in cents
OriginalPrice Integer Yes Original price in cents

PrivateIPAddressInfo

Private IP information of the instance.

Used by actions: DescribeInstances.

Name Type Description
PrivateIPAddress String Private IP of the instance.
Note: this field may return null, indicating that no valid values can be obtained.

PrivateIpAddressSpecification

Private IP information

Used by actions: AssignPrivateIpAddresses, CreateNetworkInterface, DescribeNetworkInterfaces, ModifyPrivateIpAddressesAttribute, RemovePrivateIpAddresses.

Name Type Required Description
PrivateIpAddress String Yes Private IP address.
Primary Boolean No Whether it is the primary IP.
Note: this field may return null, indicating that no valid values can be obtained.
PublicIpAddress String No Public IP address.
AddressId String No EIP instance ID, such as eip-11112222.
Description String No Private IP description.
IsWanIpBlocked Boolean No Whether the public IP is blocked.
Note: this field may return null, indicating that no valid values can be obtained.
State String No IP status:
PENDING: generating
MIGRATING: migrating
DELETING: deleting
AVAILABLE: available

Province

Province/State information

Used by actions: DescribeInstances, DescribeLoadBalancers, DescribeNode.

Name Type Description
ProvinceId String Province/State ID
ProvinceName String Province/State name

PublicIPAddressInfo

Public IP information of the instance.

Used by actions: DescribeInstances.

Name Type Description
ChargeMode String Billing mode.
PublicIPAddress String Public IP of the instance.
ISP ISP Public IP ISP of the instance.
MaxBandwidthOut Integer Outbound bandwidth cap of the instance in Mbps.
MaxBandwidthIn Integer Inbound bandwidth cap of the instance in Mbps.

RegionInfo

Region and region name (RegionName)

Used by actions: DescribeInstances, DescribeLoadBalancers, DescribeNode.

Name Type Description
Region String Region
RegionName String Region name
RegionId Integer RegionID

Route

Routing policy

Used by actions: CreateRouteTable, CreateRoutes, DeleteRoutes, DescribeRouteConflicts, DescribeRouteTables, ReplaceRoutes, ResetRoutes.

Name Type Required Description
DestinationCidrBlock String No Destination IPv4 IP range
GatewayType String No Next hop type
NORMAL_CVM: general CVM;
GatewayId String No Next hop address
You simply need to specify the gateway ID of a different next hop type, and the system will automatically match the next hop address
When GatewayType is EIP, the value of GatewayId will be fixed at 0
RouteItemId String No Unique routing policy ID
RouteDescription String No Routing policy description
Enabled Boolean No Whether to enable
RouteType String No Route type. Valid values:
USER: user route;
NETD: network probe route, which will be delivered by the system by default when you create a network probe instance and cannot be edited or deleted;
CCN: CCN route, which will be delivered by the system by default and cannot be edited or deleted.
You can only add and manipulate routes of USER type.
RouteId Integer No Routing policy ID. The IPv4 routing policy will have a meaningful value, while the IPv6 routing policy is always 0. We recommend you use the unique ID RouteItemId for the routing policy

RouteConflict

Route conflict object

Used by actions: DescribeRouteConflicts.

Name Type Description
RouteTableId String Route table instance ID
DestinationCidrBlock String The conflicting destination ports to be checked
ConflictSet Array of Route List of conflicting routing policies
Note: this field may return null, indicating that no valid values can be obtained.

RouteTable

Route table

Used by actions: CreateRouteTable, CreateRoutes, DescribeRouteTables.

Name Type Required Description
VpcId String No VPC instance ID
RouteTableId String No Route table instance ID
RouteTableName String No Route table name
AssociationSet Array of RouteTableAssociation No Association relationships of the route table
Note: this field may return null, indicating that no valid values can be obtained.
RouteSet Array of Route No IPv4 routing policy set
Note: this field may return null, indicating that no valid values can be obtained.
Main Boolean No Whether it is the default route table
CreatedTime String No Creation time

RouteTableAssociation

Association relationships of the route table

Used by actions: CreateRouteTable, CreateRoutes, DescribeRouteTables.

Name Type Required Description
SubnetId String No Subnet instance ID
RouteTableId String No Route table instance ID

RuleHealth

List of forwarding rules and health status

Used by actions: DescribeTargetHealth.

Name Type Description
Targets Array of TargetHealth Health check status of the real server bound to the rule
Note: this field may return null, indicating that no valid values can be obtained.

RunEIPDirectServiceEnabled

IP direct access information

Used by actions: ResetInstances, RunInstances.

Name Type Required Description
Enabled Boolean No Whether to enable IP direct access. Valid values:
TRUE: yes
FALSE: no
Default value: TRUE.
Currently, Windows images do not support IP direct access.

RunMonitorServiceEnabled

CM

Used by actions: ResetInstances, RunInstances.

Name Type Required Description
Enabled Boolean No Whether to enable.

RunSecurityServiceEnabled

CWP;

Used by actions: ResetInstances, RunInstances.

Name Type Required Description
Enabled Boolean No Whether to enable.
Version Integer No CWP edition. Valid values: 0: Basic Edition; 1: Pro Edition. Currently, only Basic Edition is supported

SecurityGroup

Security group object

Used by actions: CreateSecurityGroup, DescribeSecurityGroups.

Name Type Required Description
SecurityGroupId String Yes Security group instance ID, such as esg-ohuuioma.
SecurityGroupName String Yes Security group name, which can be customized with up to 60 characters.
SecurityGroupDesc String Yes Security group remarks, which can contain up to 100 characters.
IsDefault Boolean No Whether it is the default security group (which cannot be deleted).
CreatedTime String No Security group creation time.
TagSet Array of Tag No Tag key-value pairs.

SecurityGroupAssociationStatistics

Statistics on the resources associated with the security group

Used by actions: DescribeSecurityGroupAssociationStatistics.

Name Type Description
SecurityGroupId String Security group instance ID.
ECM Integer Number of ECM instances.
Module Integer Number of ECM modules.
ENI Integer Number of ENI instances.
SG Integer Number of times the security group is referenced by other security groups.
CLB Integer Number of CLB instances.
InstanceStatistics Array of InstanceStatistic Binding statistics of all instances.
TotalCount Integer Total number of all resources (excluding resources referenced by security groups).

SecurityGroupLimitSet

Security group quota limit

Used by actions: DescribeSecurityGroupLimits.

Name Type Description
SecurityGroupLimit Integer Total number of security groups that can be created
SecurityGroupPolicyLimit Integer Maximum number of rules under the security group
ReferedSecurityGroupLimit Integer Number of nested security group rules under the security group
SecurityGroupInstanceLimit Integer Number of instances associated with the security group
InstanceSecurityGroupLimit Integer Number of security groups associated with the instance
SecurityGroupModuleLimit Integer Number of modules associated with the security group
ModuleSecurityGroupLimit Integer Number of security groups associated with the module

SecurityGroupPolicy

Security group policy object

Used by actions: CreateSecurityGroupPolicies, DeleteSecurityGroupPolicies, DescribeSecurityGroupPolicies, ModifySecurityGroupPolicies, ReplaceSecurityGroupPolicy.

Name Type Required Description
PolicyIndex Integer No Security group policy index number
Protocol String No Protocol. Valid values: TCP, UDP, ICMP.
Port String No Port. Valid values: all, discrete port, range.
ServiceTemplate ServiceTemplateSpecification No Protocol port ID or protocol port group ID. ServiceTemplate and Protocol+Port are mutually exclusive.
CidrBlock String No IP range or IP address (mutually exclusive).
SecurityGroupId String No Security group instance ID, such as esg-ohuuioma.
AddressTemplate AddressTemplateSpecification No IP address ID or IP address group ID.
Action String No ACCEPT or DROP.
PolicyDescription String No Security group policy description.
ModifyTime String No Modification time, such as 2020-07-22 19:27:23
Note: this field may return null, indicating that no valid values can be obtained.
Ipv6CidrBlock String No IP range or IPv6 address (mutually exclusive).
Note: this field may return null, indicating that no valid values can be obtained.

SecurityGroupPolicySet

Security group policy set

Used by actions: CreateSecurityGroupPolicies, DeleteSecurityGroupPolicies, DescribeSecurityGroupPolicies, ModifySecurityGroupPolicies, ReplaceSecurityGroupPolicy.

Name Type Required Description
Version String No The version number of the security group policy, which will automatically increase by one each time you update the security group policy, so as to prevent expiration of the updated routing policies. If it is left empty, any conflicts will be ignored.
Egress Array of SecurityGroupPolicy No Outbound rule. You must select either an outbound rule or inbound rule.
Ingress Array of SecurityGroupPolicy No Inbound rule. You must select either outbound rule or inbound rule.

ServiceTemplateSpecification

Protocol port template

Used by actions: CreateSecurityGroupPolicies, DeleteSecurityGroupPolicies, DescribeSecurityGroupPolicies, ModifySecurityGroupPolicies, ReplaceSecurityGroupPolicy.

Name Type Required Description
ServiceId String Yes Protocol port ID, such as eppm-f5n1f8da.
ServiceGroupId String Yes Protocol port group ID, such as eppmg-f5n1f8da.

SimpleModule

Basic information of the module

Used by actions: DescribeInstances.

Name Type Description
ModuleId String Module ID
ModuleName String Module name

Snapshot

Snapshot details

Used by actions: DescribeSnapshots.

Name Type Description
Placement Placement Snapshot location.
CopyFromRemote Boolean Whether the snapshot is replicated across regions. Valid values:
  • true: yes;
  • false: no.
  • IsPermanent Boolean Whether the snapshot is a permanent snapshot. Valid values:
  • true: yes
  • false: no.
  • SnapshotName String Snapshot name, i.e., the user-defined snapshot alias. You can call ModifySnapshotAttribute to modify this field.
    Percent Integer Snapshot creation progress in percentage. This field will always be 100 once the snapshot is created successfully.
    Images Array of Image List of images associated with the snapshot.
    ShareReference Integer Number of snapshots currently shared.
    SnapshotType String Snapshot type. Valid values: PRIVATE_SNAPSHOT, SHARED_SNAPSHOT
    DiskSize Integer Size in GB of the cloud disk for which the snapshot is created.
    DiskId String ID of the cloud disk for which the snapshot is created.
    CopyingToRegions Array of String Destination region to which the snapshot is being replicated. Default value: [].
    SnapshotId String Snapshot ID.
    DiskUsage String Type of the cloud disk for which the snapshot is created. Valid values:
  • SYSTEM_DISK: system disk
  • DATA_DISK: data disk.
  • Encrypt Boolean Whether the snapshot is created from an encrypted disk. Valid values:
  • true: yes
  • false: no.
  • CreateTime Timestamp Snapshot creation time.
    ImageCount Integer Number of images associated with the snapshot.
    SnapshotState String Snapshot status. Valid values:
  • NORMAL: normal
  • CREATING: creating
  • ROLLBACKING: rolling back
  • COPYING_FROM_REMOTE: cross-region replicating
  • CHECKING_COPIED: verifying the cross-region replicated data
  • TORECYCLE: to be repossessed.
  • DeadlineTime String Snapshot expiration time.
    TimeStartShare String Time when snapshot sharing starts.
    Note: this field may return null, indicating that no valid values can be obtained.

    SrcImage

    Image source information

    Used by actions: DescribeImage, DescribeInstances, DescribeModuleDetail, DescribeSnapshots.

    Name Type Description
    ImageId String Image ID
    ImageName String Image name
    ImageOsName String System name
    ImageDescription String Image description
    Region String Region
    RegionID Integer Region ID
    RegionName String Region name
    InstanceName String Source instance name
    InstanceId String Source instance ID
    ImageType String Source image type

    Subnet

    Subnet object

    Used by actions: CreateSubnet, CreateVpc, DescribeDefaultSubnet, DescribeSubnets, DescribeVpcs.

    Name Type Description
    VpcId String VPC instance ID.
    SubnetId String Subnet instance ID, such as subnet-bthucmmy.
    SubnetName String Subnet name.
    CidrBlock String IPv4 CIDR block of the subnet.
    IsDefault Boolean Whether it is the default subnet.
    EnableBroadcast Boolean Whether to enable broadcast.
    RouteTableId String Route table instance ID, such as rtb-l2h8d7c2.
    CreatedTime String Creation time.
    AvailableIpAddressCount Integer Number of available IPs.
    Ipv6CidrBlock String IPv6 CIDR block of the subnet.
    NetworkAclId String Associated ACLID
    IsRemoteVpcSnat Boolean Whether it is an SNAT address pool subnet.
    TagSet Array of Tag Tag key-value pairs.
    Note: this field may return null, indicating that no valid values can be obtained.
    Zone String Region
    ZoneName String AZ name
    Note: this field may return null, indicating that no valid values can be obtained.
    InstanceCount Integer Number of instances
    Note: this field may return null, indicating that no valid values can be obtained.
    VpcCidrBlock String IPv4 CIDR block of the VPC.
    Note: this field may return null, indicating that no valid values can be obtained.
    VpcIpv6CidrBlock String IPv6 CIDR block of the VPC.
    Note: this field may return null, indicating that no valid values can be obtained.
    Region String Region
    Note: this field may return null, indicating that no valid values can be obtained.

    SystemDisk

    System disk description.

    Used by actions: CreateModule, DescribeModuleDetail, DescribePriceRunInstance, ModifyModuleConfig, RunInstances.

    Name Type Required Description
    DiskType String No Disk type. Valid values:
    - LOCAL_BASIC: local disk;
    - CLOUD_PREMIUM: Premium Cloud Storage;
    Default value: CLOUD_BASIC.
    DiskId String No Disk ID. This parameter is temporarily unavailable.
    DiskSize Integer No Disk size in GB.

    Tag

    Tag information.

    Used by actions: AllocateAddresses, CreateModule, CreateNetworkInterface, CreateSecurityGroup, CreateSubnet, CreateVpc, DescribeDefaultSubnet, DescribeInstances, DescribeModuleDetail, DescribeNetworkInterfaces, DescribeSecurityGroups, DescribeSubnets, DescribeVpcs, ModifySubnetAttribute, ModifyVpcAttribute, RunInstances.

    Name Type Required Description
    Key String Yes Tag key.
    Note: this field may return null, indicating that no valid values can be obtained.
    Value String Yes Tag value.
    Note: this field may return null, indicating that no valid values can be obtained.

    TagInfo

    Tag information.

    Used by actions: CreateLoadBalancer, DescribeLoadBalancers.

    Name Type Required Description
    TagKey String No Tag key.
    TagValue String No Tag value.

    TagSpecification

    Resource type tag

    Used by actions: CreateModule, RunInstances.

    Name Type Required Description
    ResourceType String Yes Resource type. Valid values: instance, module
    Tags Array of Tag Yes Tag list

    Target

    CLB backend target

    Used by actions: BatchModifyTargetWeight, ModifyTargetPort, ModifyTargetWeight.

    Name Type Required Description
    Port Integer No Listening port of the real server
    Note: this field may return null, indicating that no valid values can be obtained.
    InstanceId String No CVM instance ID
    Note: this field may return null, indicating that no valid values can be obtained.
    Weight Integer No Forwarding weight of the real server. Value range: [0, 100]. Default value: 10.
    Note: this field may return null, indicating that no valid values can be obtained.
    EniIp String No You need to pass in this parameter when binding an ENI. It represents the IP address of the ENI. You must bind an ENI to a CVM instance first before you can bind it to a CLB instance. Note: you must pass in either InstanceId or EniIp.
    Note: this field may return null, indicating that no valid values can be obtained.

    TargetHealth

    Health check status of the backend

    Used by actions: DescribeTargetHealth.

    Name Type Description
    IP String Private IP of the target
    Note: this field may return null, indicating that no valid values can be obtained.
    Port Integer Port bound to the target
    Note: this field may return null, indicating that no valid values can be obtained.
    HealthStatus Boolean Current health status. Valid values: true: healthy; false: unhealthy (e.g., check not started, checking, or exceptional status). CLB instance will route traffic to only healthy real servers whose weights are greater than 0.
    Note: this field may return null, indicating that no valid values can be obtained.
    TargetId String Instance ID of the target
    Note: this field may return null, indicating that no valid values can be obtained.
    HealthStatusDetail String Detailed information of the current health status. Valid values: Alive: healthy; Dead: exceptional; Unknown: check not started/checking/unknown status; Close: health check not configured.
    Note: this field may return null, indicating that no valid values can be obtained.

    TargetsWeightRule

    Description of targets and their weights

    Used by actions: BatchModifyTargetWeight.

    Name Type Required Description
    ListenerId String No CLB listener ID
    Note: this field may return null, indicating that no valid values can be obtained.
    Targets Array of Target No List of real servers for which to modify the weights
    Note: this field may return null, indicating that no valid values can be obtained.
    Weight Integer No New forwarding weight of the real server. Value range: 0–100.
    Note: this field may return null, indicating that no valid values can be obtained.

    TaskInput

    Task query

    Used by actions: DescribeTaskStatus.

    Name Type Required Description
    Operation String Yes Operation name, i.e., API name, such as CreateImage
    TaskId String Yes Task ID

    TaskOutput

    Output parameter of the task query

    Used by actions: DescribeTaskStatus.

    Name Type Description
    TaskId String Task ID
    Message String Status description
    Status String Status value. Valid values: SUCCESS, FAILED, OPERATING
    AddTime String Task submission time
    EndTime String Task end time
    Operation String Operation name

    VirtualPrivateCloud

    VPC information configuration.

    Used by actions: DescribeInstances.

    Name Type Required Description
    VpcId String Yes VPC ID, such as vpc-xxx.
    SubnetId String Yes Subnet ID of the VPC, such as subnet-xxx.
    AsVpcGateway Boolean No Whether it is used as a public gateway. The public gateway can be used only when the instance has a public IP and resides in a VPC. Valid values:
    TRUE: yes
    FALSE: no

    Default value: FALSE.
    PrivateIpAddresses Array of String No Array of VPC subnet IPs. This parameter can be used to create instances or modify the VPC attributes of instances.
    Ipv6AddressCount Integer No Number of the IPv6 addresses to be randomly generated for the ENI.

    VpcInfo

    VPC object.

    Used by actions: CreateVpc, DescribeVpcs.

    Name Type Description
    VpcName String VPC name.
    VpcId String VPC instance ID, such as vpc-azd4dt1c.
    CidrBlock String IPv4 CIDR block of the VPC.
    IsDefault Boolean Whether it is the default VPC.
    EnableMulticast Boolean Whether to enable multicast.
    CreatedTime String Creation time.
    DnsServerSet Array of String List of DNS servers.
    Note: this field may return null, indicating that no valid values can be obtained.
    DomainName String DHCP domain option value.
    DhcpOptionsId String DHCP option set ID.
    EnableDhcp Boolean Whether to enable DHCP.
    Ipv6CidrBlock String IPv6 CIDR block of the VPC.
    TagSet Array of Tag Tag key-value pair
    Note: this field may return null, indicating that no valid values can be obtained.
    AssistantCidrSet Array of AssistantCidr Secondary CIDR block
    Note: this field may return null, indicating that no valid values can be obtained.
    Region String Region
    Description String Description
    RegionName String Region name
    SubnetCount Integer Number of included subnets
    InstanceCount Integer Number of included instances

    ZoneInfo

    Zone information

    Used by actions: DescribeInstances, DescribeLoadBalancers, DescribeMonthPeakNetwork, DescribeNode.

    Name Type Description
    ZoneId Integer ZoneId
    ZoneName String ZoneName
    Zone String Zone

    ZoneInstanceCountISP

    Combination of the instance AZ, number of instances to be created, and ISP;

    Used by actions: RunInstances.

    Name Type Required Description
    Zone String Yes The AZ in which to create an instance.
    InstanceCount Integer Yes Number of instances to be created in the current AZ.
    ISP String Yes ISP name. Valid values:
    CTCC: China Telecom
    CUCC: China Unicom
    CMCC: China Mobile
    If there are multiple ISP names, you need to separate them by semicolons, such as CMCC;CUCC;CTCC. To use multiple ISPs, contact Tencent Cloud customer service for assistance.
    VpcId String No ID of the specified VPC. You must specify both SubnetId and VpcId or neither
    SubnetId String No ID of the specified subnet. You must specify both SubnetId and VpcId or neither
    PrivateIpAddresses Array of String No Private IP of the specified primary ENI. You must specify both SubnetId and VpcId at the same time. The number of IP addresses must be the same as InstanceCount. You can get the private IP of the secondary ENI of a multi-IP server through DHCP in the same subnet.
    Ipv6AddressCount Integer No Number of the IPv6 addresses to be randomly generated for the ENI, which cannot be greater than 1.

    ZoneInstanceInfo

    Instance information of the zone

    Used by actions: DescribeModuleDetail.

    Name Type Description
    ZoneName String Zone name
    InstanceNum Integer Number of instances
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support
    Hong Kong, China
    +852 800 906 020 (Toll Free)
    United States
    +1 844 606 0804 (Toll Free)
    United Kingdom
    +44 808 196 4551 (Toll Free)
    Canada
    +1 888 605 7930 (Toll Free)
    Australia
    +61 1300 986 386 (Toll Free)
    EdgeOne hotline
    +852 300 80699
    More local hotlines coming soon