Data Types

Last updated: 2020-03-06 20:27:50

AccountAttribute

Account attribute object

Used by actions: DescribeAccountAttributes.

Name Type Description
AttributeName String Attribute name
AttributeValues Array of String Attribute values

Address

Detailed EIP information

Used by actions: DescribeAddresses.

Name Type Description
AddressId String EIP ID, the unique ID of the EIP.
AddressName String The EIP name.
AddressStatus String Possible EIP states are 'CREATING', 'BINDING', 'BIND', 'UNBINDING', 'UNBIND', 'OFFLINING', and 'BIND_ENI'.
AddressIp String The public IP address
InstanceId String The ID of the bound resource instance. This can be a CVM or NAT.
CreatedTime Timestamp The creation time, which follows the ISO8601 standard and uses UTC time in the format of YYYY-MM-DDThh:mm:ssZ.
NetworkInterfaceId String The ID of the bound ENI
PrivateAddressIp String The private IP of the bound resources
IsArrears Boolean The isolation status of the resource. True indicates the EIP is isolated. False indicates that the resource is not isolated.
IsBlocked Boolean The block status of the resource. True indicates the EIP is blocked. False indicates that the EIP is not blocked.
IsEipDirectConnection Boolean Whether the EIP supports direct connection mode. True indicates the EIP supports direct connection. False indicates that the resource does not support direct connection.
AddressType String The resource type of the EIP. This includes CalcIP, WanIP, EIP, and AnycastEIP. Among these, CalcIP indicates the device IP, WanIP indicates the common public IP, EIP indicates Elastic IP, and AnycastEip indicates accelerated EIP.
CascadeRelease Boolean Whether the EIP is automatically released after being unbound. True indicates the EIP will be automatically released after being unbound. False indicates the EIP will not be automatically released after being unbound.

AddressTemplate

IP address template

Used by actions: CreateAddressTemplate、DescribeAddressTemplates.

Name Type Description
AddressTemplateName String IP address template name.
AddressTemplateId String The unique ID of the IP address template instance.
AddressSet Array of String IP address information.
CreatedTime String Creation Time.

AddressTemplateGroup

IP address template group

Used by actions: CreateAddressTemplateGroup、DescribeAddressTemplateGroups.

Name Type Description
AddressTemplateGroupName String IP address template group name.
AddressTemplateGroupId String IP address template group instance ID, such as ipmg-dih8xdbq.
AddressTemplateIdSet Array of String IP address template ID.
CreatedTime String Creation Time.

AddressTemplateSpecification

IP address template.

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

Name Type Description
AddressId String The ID of the IP address, such as ipm-2uw6ujo6.
AddressGroupId String The ID of the IP address group, such as ipmg-2uw6ujo6.

AssistantCidr

Information about the secondary CIDR of the VPC.

Used by actions: CreateVpc、DescribeVpcs.

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

CCN

The CCN object

Used by actions: CreateCcn、DescribeCcns.

Name Type Description
CcnId String The unique ID of the CCN
CcnName String The name of the CCN
CcnDescription String The detailed information of the CCN
InstanceCount Integer The number of associated instances
CreateTime Timestamp The creation time
State String The instance status. 'ISOLATED': Being isolated (instance is in arrears and service is suspended). 'AVAILABLE': Operating.
QosLevel String The instance service quality. ’PT’: Platinum , 'AU': Gold, 'AG': Silver.
InstanceChargeType String The billing method. POSTPAID indicates postpaid.
Note: This field may return null, indicating that no valid values can be obtained.
BandwidthLimitType String The limit type. INTER_REGION_LIMIT is the limit between regions. OUTER_REGION_LIMIT is a region egress limit.
Note: This field may return null, indicating no valid value.

CcnAttachedInstance

The instance object associated with a CCN

Used by actions: DescribeCcnAttachedInstances.

Name Type Description
CcnId String The ID of a CCN instance.
InstanceType String The type of associated instances:
  • VPC: VPC
  • DIRECTCONNECT: Direct Connect
  • BMVPC: BM VPC
  • InstanceId String The ID of the associated instance.
    InstanceName String The name of the associated instance.
    InstanceRegion String The region to which the associated instance belongs, such as ap-guangzhou.
    InstanceUin String The UIN (root account) to which the associated instance belongs.
    CidrBlock Array of String The CIDR of the associated instance.
    State String The status of the associated instance:
  • PENDING: In application
  • ACTIVE: Connected
  • EXPIRED: Expired
  • REJECTED: Rejected
  • DELETED: Deleted
  • FAILED: Failed (it will be asynchronously unbound after 2 hours)
  • ATTACHING: binding
  • DETACHING: Unbinding
  • DETACHFAILED: The unbinding failed (it will be asynchronously unbound after 2 hours)
  • AttachedTime Timestamp Association Time.
    CcnUin String The UIN (root account) to which the CCN belongs.

    CcnInstance

    The instance object associated with a CCN.

    Used by actions: AcceptAttachCcnInstances、AttachCcnInstances、DetachCcnInstances、RejectAttachCcnInstances、ResetAttachCcnInstances.

    Name Type Required Description
    InstanceId String Yes The ID of the associated instance.
    InstanceRegion String Yes The region to which the associated instance ID belongs, such as ap-guangzhou.
    InstanceType String No The type of the associated instance. Available values are:
  • VPC: VPC
  • DIRECTCONNECT: Direct Connect
  • BMVPC: BM VPC
  • CcnRegionBandwidthLimit

    The outbound bandwidth cap of the CCN region

    Used by actions: SetCcnRegionBandwidthLimits.

    Name Type Required Description
    Region String Yes Region, such as ap-guangzhou
    BandwidthLimit Integer Yes The outbound bandwidth cap. Units: Mbps
    IsBm Boolean No Whether it is a BM region. The default is false.
    DstRegion String No The target region, such as ap-shanghai
    Note: This field may return null, indicating no valid value.
    DstIsBm Boolean No Whether the target region is a BM region. The default is false.

    CcnRoute

    The CCN routing policy object

    Used by actions: DescribeCcnRoutes.

    Name Type Description
    RouteId String The ID of the routing policy
    DestinationCidrBlock String Destination
    InstanceType String The type of the next hop (associated instance type). Available types: VPC, DIRECTCONNECT
    InstanceId String The next hop (associated instance)
    InstanceName String The name of the next hop (associated instance name)
    InstanceRegion String The region of the next hop (the region of the associated instance)
    UpdateTime Timestamp Update Time
    Enabled Boolean Whether the route is enabled
    InstanceUin String The UIN (root account) to which the associated instance belongs

    ClassicLinkInstance

    Classiclink instance

    Used by actions: DescribeClassicLinkInstances.

    Name Type Description
    VpcId String VPC instance ID
    InstanceId String The unique ID of the CVM instance

    CustomerGatewayVendor

    Customer gateway vendor information object.

    Used by actions: DownloadCustomerGatewayConfiguration.

    Name Type Required Description
    Platform String Yes Platform.
    SoftwareVersion String Yes Software version.
    VendorName String Yes Vendor name.

    DefaultVpcSubnet

    Default VPC and subnet

    Used by actions: CreateDefaultVpc.

    Name Type Description
    VpcId String Default VpcId
    SubnetId String Default SubnetId

    DestinationIpPortTranslationNatRule

    The port forwarding rules of the NAT gateway

    Used by actions: CreateNatGateway、CreateNatGatewayDestinationIpPortTranslationNatRule、DeleteNatGatewayDestinationIpPortTranslationNatRule、DescribeNatGateways、ModifyNatGatewayDestinationIpPortTranslationNatRule.

    Name Type Description
    IpProtocol String Network protocol. Available choices: TCP, UDP.
    PublicIpAddress String EIP.
    PublicPort Integer Public port.
    PrivateIpAddress String Private network address.
    PrivatePort Integer Private network port.
    Description String NAT gateway forwarding rule description.

    DirectConnectGatewayCcnRoute

    The object of the CCN route (IDC IP range) of the Direct Connect gateway

    Used by actions: CreateDirectConnectGatewayCcnRoutes、DescribeDirectConnectGatewayCcnRoutes、ReplaceDirectConnectGatewayCcnRoutes.

    Name Type Description
    RouteId String Route ID.
    DestinationCidrBlock String IDC IP range.
    ASPath Array of String The AS-Path attribute of BGP.

    Filter

    Filter

    Used by actions: DescribeAddressTemplateGroups、DescribeAddressTemplates、DescribeAddresses、DescribeCcnAttachedInstances、DescribeCcnRoutes、DescribeCcns、DescribeHaVips、DescribeNatGatewayDestinationIpPortTranslationNatRules、DescribeNatGateways、DescribeNetDetectStates、DescribeNetDetects、DescribeSecurityGroups、DescribeServiceTemplateGroups、DescribeServiceTemplates、DescribeSubnets、DescribeVpcs、DescribeVpnConnections.

    Name Type Required Description
    Name String Yes The attribute name. If more than one Filter exists, the logical relation between these Filters is AND.
    Values Array of String Yes The attribute value. If there are multiple Values for one Filter, the logical relation between these Values under the same Filter is OR.

    FilterObject

    Filter key-value pair

    Used by actions: DescribeClassicLinkInstances、DescribeVpnGateways.

    Name Type Required Description
    Name String Yes The attribute name. If more than one Filter exists, the logical relation between these Filters is AND.
    Values Array of String Yes The attribute value. If there are multiple Values for one Filter, the logical relation between these Values under the same Filter is OR.

    GatewayFlowMonitorDetail

    The gateway traffic monitoring details

    Used by actions: DescribeGatewayFlowMonitorDetail.

    Name Type Description
    PrivateIpAddress String Origin IP.
    InPkg Integer Inbound packets.
    OutPkg Integer Outbound packets.
    InTraffic Integer Inbound bandwidth, unit: Byte.
    OutTraffic Integer Outbound bandwidth, unit: Byte.

    HaVip

    HAVIP description information

    Used by actions: CreateHaVip、DescribeHaVips.

    Name Type Description
    HaVipId String The ID of the HAVIP. This is the unique identifier of the HAVIP.
    HaVipName String The name of the HAVIP.
    Vip String The virtual IP address.
    VpcId String The ID of the VPC to which the HAVIP belongs.
    SubnetId String The ID of the subnet to which the HAVIP belongs.
    NetworkInterfaceId String The ID of the ENI associated with the HAVIP.
    InstanceId String The ID of the bound instance.
    AddressIp String Bound EIP.
    State String Status:
  • AVAILABLE: Operating
  • UNBIND: Not bound
  • CreatedTime Timestamp Creation Time.

    IKEOptionsSpecification

    Internet Key Exchange (IKE) configuration. IKE has a self-protection mechanism. The network security protocol is configured by the user.

    Used by actions: CreateVpnConnection、DescribeVpnConnections、ModifyVpnConnectionAttribute.

    Name Type Required Description
    PropoEncryAlgorithm String No Encryption algorithm. Available values: '3DES-CBC', 'AES-CBC-128', 'AES-CBS-192', 'AES-CBC-256', and 'DES-CBC'. Default is 3DES-CBC.
    PropoAuthenAlgorithm String No Verification algorithm. Available value: 'MD5' and 'SHA1'. Default is MD5.
    ExchangeMode String No Negotiation mode. Available values: 'AGGRESSIVE' and 'MAIN'. Default is MAIN.
    LocalIdentity String No Type of local identity. Available values: 'ADDRESS' and 'FQDN'. Default is ADDRESS.
    RemoteIdentity String No Type of remote identity. Available values: 'ADDRESS' and 'FQDN'. Default is ADDRESS.
    LocalAddress String No Local identity. When ADDRESS is selected for LocalIdentity, LocalAddress is required. The default LocalAddress is the public IP of the VPN gateway.
    RemoteAddress String No Remote identity. When ADDRESS is selected for RemoteIdentity, RemoteAddress is required.
    LocalFqdnName String No Local identity. When FQDN is selected for LocalIdentity, LocalFqdnName is required.
    RemoteFqdnName String No Remote identity. When FQDN is selected for RemoteIdentity, RemoteFqdnName is required.
    DhGroupName String No DH group. Specify the DH group used for exchanging the key via IKE. Available values: 'GROUP1', 'GROUP2', 'GROUP5', 'GROUP14', and 'GROUP24'.
    IKESaLifetimeSeconds Integer No IKE SA lifetime (in sec). Value range: 60-604800
    IKEVersion String No IKE version

    IPSECOptionsSpecification

    IPSec configuration. The IPSec secure session configuration is provided by Tencent Cloud.

    Used by actions: CreateVpnConnection、DescribeVpnConnections、ModifyVpnConnectionAttribute.

    Name Type Required Description
    EncryptAlgorithm String No Encryption algorithm. Available values: '3DES-CBC', 'AES-CBC-128', 'AES-CBC-192', 'AES-CBC-256', 'DES-CBC', and 'NULL'. Default is AES-CBC-128.
    IntegrityAlgorith String No Verification algorithm. Available value: 'MD5' and 'SHA1'. Default is:
    IPSECSaLifetimeSeconds Integer No IPsec SA lifetime (in sec). Value range: 180-604800
    PfsDhGroup String No PFS. Available value: 'NULL', 'DH-GROUP1', 'DH-GROUP2', 'DH-GROUP5', 'DH-GROUP14', and 'DH-GROUP24'. Default is NULL.
    IPSECSaLifetimeTraffic Integer No IPsec SA lifetime (in KB). Value range: 2560-604800

    InstanceChargePrepaid

    Prepaid (monthly subscription) billing object.

    Used by actions: CreateVpnGateway、InquiryPriceCreateVpnGateway.

    Name Type Required Description
    Period Integer Yes Purchased usage period (in month). Value range: [1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36].
    RenewFlag String No Auto-renewal ID. Value range: NOTIFY_AND_AUTO_RENEW: notify expiry and renew automatically, NOTIFY_AND_MANUAL_RENEW: notify expiry but do not renew automatically. The default is NOTIFY_AND_MANUAL_RENEW

    InstanceStatistic

    Statistics used to describe the instance

    Used by actions: DescribeSecurityGroupAssociationStatistics.

    Name Type Description
    InstanceType String Type of instance
    InstanceCount Integer Number of instances

    Ipv6Address

    IPv6 address information.

    Used by actions: AssignIpv6Addresses、CreateNetworkInterface、ModifyIpv6AddressesAttribute、UnassignIpv6Addresses.

    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 a primary IP.
    AddressId String No The ID of the EIP instance, such as eip-hxlqja90.
    Description String No Message description
    IsWanIpBlocked Boolean No Whether the public IP is blocked.
    State String No IPv6 address status:
  • PENDING: Creating
  • MIGRATING: Migrating
  • DELETING: Deleting
  • AVAILABLE: Available
  • Ipv6SubnetCidrBlock

    IPv6 subnet IP range object.

    Used by actions: AssignIpv6SubnetCidrBlock、UnassignIpv6SubnetCidrBlock.

    Name Type Required Description
    SubnetId String Yes The ID of the subnet instance, such as subnet-pxir56ns.
    Ipv6CidrBlock String No The IPv6 subnet IP range, such as 3402:4e00:20:1001::/64

    ItemPrice

    The pricing information of a single billing item

    Used by actions: InquiryPriceCreateVpnGateway.

    Name Type Description
    UnitPrice Float The pay-as-you-go billing method. Unit: CNY.
    ChargeUnit String Pay-as-you-go billing method. Value Range: HOUR: Indicates billing by the hour. Scenarios using this hourly billing unit include: Instances postpaid on an hourly basis (POSTPAID_BY_HOUR), and bandwidth postpaid on an hourly basis (BANDWIDTH_POSTPAID_BY_HOUR). GB: Indicates billing on a per-GB basis. Scenarios using this billing unit include: Traffic postpaid on an hourly basis (TRAFFIC_POSTPAID_BY_HOUR).
    OriginalPrice Float Original price of the prepaid product. Unit: CNY.
    DiscountPrice Float Discount price of the prepaid product. Unit: CNY.

    NatGateway

    NAT gateway object.

    Used by actions: CreateNatGateway、DescribeNatGateways.

    Name Type Description
    NatGatewayId String NAT gateway ID.
    NatGatewayName String NAT gateway name.
    CreatedTime String NAT gateway creation time.
    State String The status of the NAT gateway.
    'PENDING': Creating, 'DELETING': Deleting, 'AVAILABLE': Operating, 'UPDATING': Upgrading,
    ‘FAILED’: Failed.
    InternetMaxBandwidthOut Integer The maximum outbound bandwidth of the gateway. Unit: Mbps.
    MaxConcurrentConnection Integer The concurrent connections cap of the gateway.
    PublicIpAddressSet Array of NatGatewayAddress The public IP object array of the bound NAT gateway.
    NetworkState String The NAT gateway status. AVAILABLE: Operating, UNAVAILABLE: Unavailable, INSUFFICIENT: Account is in arrears and the service is suspended.
    DestinationIpPortTranslationNatRuleSet Array of DestinationIpPortTranslationNatRule The port forwarding rules of the NAT gateway.
    VpcId String VPC instance ID.
    Zone String The availability zone in which the NAT gateway is located.

    NatGatewayAddress

    The EIP bound to the NAT gateway

    Used by actions: CreateNatGateway、DescribeNatGateways.

    Name Type Description
    AddressId String The unique ID of the Elastic IP (EIP), such as eip-11112222.
    PublicIpAddress String The public IP address, such as 123.121.34.33.
    IsBlocked Boolean The block status of the resource. true indicates the EIP is blocked. false indicates that the EIP is not blocked.

    NatGatewayDestinationIpPortTranslationNatRule

    The port forwarding rules of the NAT gateway

    Used by actions: DescribeNatGatewayDestinationIpPortTranslationNatRules.

    Name Type Description
    IpProtocol String Network protocol. Available choices: TCP, UDP.
    PublicIpAddress String EIP.
    PublicPort Integer Public port.
    PrivateIpAddress String Private network address.
    PrivatePort Integer Private network port.
    Description String NAT gateway forwarding rule description.
    NatGatewayId String NAT gateway ID.
    Note: This field may return null, indicating no valid value.
    VpcId String VPC ID.
    Note: This field may return null, indicating no valid value.
    CreatedTime String The creation time of the NAT gateway forwarding rule.
    Note: This field may return null, indicating no valid value.

    NetDetect

    The network detection object.

    Used by actions: CreateNetDetect、DescribeNetDetects.

    Name Type Description
    VpcId String The ID of a VPC instance, such as vpc-12345678.
    VpcName String The name of a VPC instance.
    SubnetId String The ID of a subnet instance, such as subnet-12345678.
    SubnetName String The name of a subnet instance.
    NetDetectId String The ID of a network detection instance, such as netd-12345678.
    NetDetectName String The name of a network detection instance. The maximum length is 60 characters.
    DetectDestinationIp Array of String The array of detection destination IPv4 addresses, which contains at most two IP addresses.
    DetectSourceIp Array of String The array of detection source IPv4 addresses automatically allocated by the system. The length is 2.
    NextHopType String The type of the next hop. Currently supported types are:
    VPN: VPN gateway;
    DIRECTCONNECT: direct connect gateway;
    PEERCONNECTION: peering connection;
    NAT: NAT gateway;
    NORMAL_CVM: normal CVM.
    NextHopDestination String The next-hop destination gateway. The value is related to NextHopType.
    If NextHopType is set to VPN, the value of this parameter is the VPN gateway ID, such as vpngw-12345678.
    If NextHopType is set to DIRECTCONNECT, the value of this parameter is the direct connect gateway ID, such as dcg-12345678.
    If NextHopType is set to PEERCONNECTION, the value of this parameter is the peering connection ID, such as pcx-12345678.
    If NextHopType is set to NAT, the value of this parameter is the NAT gateway ID, such as nat-12345678.
    If NextHopType is set to NORMAL_CVM, the value of this parameter is the IPv4 address of the CVM, such as 10.0.0.12.
    NextHopName String The name of the next-hop gateway.
    Note: This field may return null, indicating that no valid values can be obtained.
    NetDetectDescription String Network detection description.
    Note: This field may return null, indicating that no valid values can be obtained.
    CreateTime Timestamp The creation time.
    Note: This field may return null, indicating that no valid values can be obtained.

    NetDetectIpState

    The verification result of the network detection destination IP address.

    Used by actions: CheckNetDetectState、DescribeNetDetectStates.

    Name Type Description
    DetectDestinationIp String The destination IPv4 address of network detection.
    State Integer The detection result.
    0: successful;
    -1: no packet loss occurred during routing;
    -2: packet loss occurred when outbound traffic is blocked by the ACL;
    -3: packet loss occurred when inbound traffic is blocked by the ACL;
    -4: other errors.
    Delay Integer The latency. Unit: ms.
    PacketLossRate Integer The packet loss rate.

    NetDetectState

    The network detection verification result.

    Used by actions: DescribeNetDetectStates.

    Name Type Description
    NetDetectId String The ID of a network detection instance, such as netd-12345678.
    NetDetectIpStateSet Array of NetDetectIpState The array of network detection destination IP verification results.

    NetworkInterface

    ENI

    Used by actions: CreateNetworkInterface.

    Name Type Description
    NetworkInterfaceId String The ID of the ENI instance, 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 group.
    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.
    Attachment NetworkInterfaceAttachment Bound CVM object.
    Note: This field may return null, indicating no valid value.
    Zone String Availability Zone.
    CreatedTime String Creation Time.
    Ipv6AddressSet Array of Ipv6Address The IPv6 address list.
    TagSet Array of Tag Tag key-value pair.
    EniType Integer The ENI type. 0: ENI. 1: EVM ENI.

    NetworkInterfaceAttachment

    Binding relationship of the ENI

    Used by actions: CreateNetworkInterface.

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

    Price

    Price

    Used by actions: InquiryPriceCreateVpnGateway.

    Name Type Description
    InstancePrice ItemPrice Instance price.
    BandwidthPrice ItemPrice Network price.

    PrivateIpAddressSpecification

    Private IP information

    Used by actions: CreateNetworkInterface、ModifyPrivateIpAddressesAttribute、UnassignPrivateIpAddresses.

    Name Type Required Description
    PrivateIpAddress String Yes Private IP address.
    Primary Boolean No Whether it is a primary IP.
    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.
    State String No IP status:
    PENDING: Creating
    MIGRATING: Migrating
    DELETING: Deleting
    AVAILABLE: Available

    Quota

    Quota description information

    Used by actions: DescribeAddressQuota.

    Name Type Description
    QuotaId String Quota name. Value range:
  • TOTAL_EIP_QUOTA:EIP quota under the user's current region
  • DAILY_EIP_APPLY: Number of EIP applications submitted daily under the user's current region
  • DAILY_PUBLIC_IP_ASSIGN: Number of public IP reassignments under the user's current region.
  • QuotaCurrent Integer Current count
    QuotaLimit Integer Quota

    Route

    Routing policy object

    Used by actions: CreateRouteTable、CreateRoutes、DeleteRoutes、ReplaceRoutes、ResetRoutes.

    Name Type Required Description
    DestinationCidrBlock String Yes Destination IP range, such as 112.20.51.0/24. Values cannot be in the VPC IP range.
    GatewayType String Yes The type of the next hop. Currently supported types include:
    CVM: Public gateway-type CVM;
    VPN: VPN gateway;
    DIRECTCONNECT: Direct connect gateway;
    PEERCONNECTION: Peering connection;
    SSLVPN: sslvpn gateway;
    NAT: NAT gateway;
    NORMAL_CVM: Normal CVM;
    EIP: The public IP of the CVM;
    CCN: Cloud Connect Network.
    GatewayId String Yes 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.
    Important note: When the GatewayType is EIP, the GatewayId has a fixed value 0
    RouteId Integer No The ID of the routing policy.
    RouteDescription String No The description of the routing policy.
    Enabled Boolean No Whether it is enabled
    RouteType String No The route type. Currently, the following types are supported:
    USER: User route;
    NETD: Network probe route. When creating a network probe route, the system delivers by default. It cannot be edited or deleted;
    CCN: CCN route. The system delivers by default. It cannot be edited or deleted.
    Users can only add and operate USER-type routes.

    RouteTable

    Route table object

    Used by actions: CreateRouteTable、CreateRoutes.

    Name Type Description
    VpcId String VPC instance ID.
    RouteTableId String The route table instance ID, such as rtb-azd4dt1c.
    RouteTableName String Route table name.
    AssociationSet Array of RouteTableAssociation The association relationships of the route table.
    RouteSet Array of Route Route table policy set.
    Main Boolean Whether it is the default route table.
    CreatedTime String Creation Time.

    RouteTableAssociation

    The association relationships of the route table

    Used by actions: CreateRouteTable、CreateRoutes.

    Name Type Description
    SubnetId String Subnet instance ID.
    RouteTableId String Route table instance ID.

    SecurityGroup

    Security group object

    Used by actions: CreateSecurityGroup、DescribeSecurityGroups.

    Name Type Required Description
    SecurityGroupId String Yes The security group instance ID, such as sg-ohuuioma.
    SecurityGroupName String Yes Security group can be named freely, but cannot exceed 60 characters.
    SecurityGroupDesc String Yes The remarks for the security group. The maximum length is 100 characters.
    ProjectId String No The project id is 0 by default. You can query this in the project management page of the Qcloud console.
    IsDefault Boolean No Whether it is the default security group (which cannot be deleted).
    CreatedTime String No Security group creation time.

    SecurityGroupAssociationStatistics

    Statistics on the instances associated with the security group

    Used by actions: DescribeSecurityGroupAssociationStatistics.

    Name Type Description
    SecurityGroupId String Security group instance ID.
    CVM Integer Number of CVM instances.
    CDB Integer Number of database instances.
    ENI Integer Number of ENI instances.
    SG Integer Number of times a security group is referenced by other security groups
    CLB Integer Number of load balancer instances.
    InstanceStatistics Array of InstanceStatistic The binding statistics for all instances.

    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. Values: TCP, UDP, ICMP
    Port String No Port (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 (mutually exclusive).
    Ipv6CidrBlock String No The CIDR block or IPv6 (mutually exclusive).
    SecurityGroupId String No The security group instance ID, such as sg-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 The last modification time of the security group.

    SecurityGroupPolicySet

    Security group policy set

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

    Name Type Required Description
    Version String No The version of the security group policy. The version number is automatically increased by one each time users update the security policy, to prevent the expiration of updated routing policies. Conflict is ignored if it is left empty.
    Egress Array of SecurityGroupPolicy No Outbound policy.
    Ingress Array of SecurityGroupPolicy No Inbound policy.

    SecurityPolicyDatabase

    SecurityPolicyDatabase policy

    Used by actions: CreateVpnConnection、DescribeVpnConnections、ModifyVpnConnectionAttribute.

    Name Type Required Description
    LocalCidrBlock String Yes Local IP range
    RemoteCidrBlock Array of String Yes Opposite IP range

    ServiceTemplate

    Protocol port template

    Used by actions: CreateServiceTemplate、DescribeServiceTemplates.

    Name Type Description
    ServiceTemplateId String Protocol port instance ID, such as ppm-f5n1f8da.
    ServiceTemplateName String Template name.
    ServiceSet Array of String Protocol port information.
    CreatedTime String Creation Time.

    ServiceTemplateGroup

    Protocol port template group

    Used by actions: CreateServiceTemplateGroup、DescribeServiceTemplateGroups.

    Name Type Description
    ServiceTemplateGroupId String Protocol port template group instance ID, such as ppmg-2klmrefu.
    ServiceTemplateGroupName String Protocol port template group name.
    ServiceTemplateIdSet Array of String Protocol port template instance ID.
    CreatedTime String Creation Time.

    ServiceTemplateSpecification

    Protocol port template

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

    Name Type Description
    ServiceId String Protocol port ID, such as ppm-f5n1f8da.
    ServiceGroupId String Protocol port group ID, such as ppmg-f5n1f8da.

    Subnet

    Subnet object

    Used by actions: CreateSubnet、CreateSubnets、CreateVpc、DescribeSubnets、DescribeVpcs.

    Name Type Description
    VpcId String The ID of the VPC instance.
    SubnetId String Subnet instance ID, such as subnet-bthucmmy.
    SubnetName String Subnet name.
    CidrBlock String The IPv4 CIDR of the subnet.
    IsDefault Boolean Whether it is the default subnet.
    EnableBroadcast Boolean Whether to enable broadcast.
    Zone String Availability Zone.
    RouteTableId String The route table instance ID, such as rtb-l2h8d7c2.
    CreatedTime String Creation Time.
    AvailableIpAddressCount Integer The number of available IPs.
    Ipv6CidrBlock String The IPv6 CIDR of the subnet.
    NetworkAclId String The associated ACLID
    IsRemoteVpcSnat Boolean Whether it is a SNAT address pool subnet.

    SubnetInput

    Subnet object

    Used by actions: CreateSubnets.

    Name Type Required Description
    CidrBlock String Yes The CIDR of the subnet.
    SubnetName String Yes Subnet name.
    Zone String Yes The availability zone, such as ap-guangzhou-2.
    RouteTableId String No The specified associated route table, such as rtb-3ryrwzuu.

    Tag

    Tag key-value pair

    Used by actions: CreateNetworkInterface、CreateVpc、DescribeVpcs.

    Name Type Description
    Key String Tag key
    Note: This field may return null, indicating no valid value.
    Value String Tag value
    Note: This field may return null, indicating no valid value.

    Vpc

    Virtual Private Cloud (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 The IPv4 CIDR of the VPC.
    IsDefault Boolean Whether it is the default VPC.
    EnableMulticast Boolean Whether multicast is enabled.
    CreatedTime String Creation Time.
    DnsServerSet Array of String DNS list.
    DomainName String DHCP domain name option value.
    DhcpOptionsId String DHCP option set ID.
    EnableDhcp Boolean Whether DHCP is enabled.
    Ipv6CidrBlock String The IPv6 CIDR of the VPC.
    TagSet Array of Tag Tag key-value pair
    AssistantCidrSet Array of AssistantCidr The secondary CIDR block.
    Note: This field may return null, indicating that no valid values can be obtained.

    VpcIpv6Address

    VPC private IPv6 object.

    Used by actions: DescribeVpcIpv6Addresses.

    Name Type Description
    Ipv6Address String VPC private IPv6 address
    CidrBlock String The IPv6 CIDR belonging to the subnet.
    Ipv6AddressType String IPv6 type.
    CreatedTime String IPv6 application time.

    VpcPrivateIpAddress

    VPC private IP object.

    Used by actions: DescribeVpcPrivateIpAddresses.

    Name Type Description
    PrivateIpAddress String VPC private IP.
    CidrBlock String The CIDR belonging to the subnet.
    PrivateIpAddressType String Private IP type.
    CreatedTime Timestamp IP application time.

    VpnConnection

    VPN tunnel object.

    Used by actions: CreateVpnConnection、DescribeVpnConnections.

    Name Type Description
    VpnConnectionId String Tunnel instance ID.
    VpnConnectionName String Tunnel name.
    VpcId String VPC instance ID.
    VpnGatewayId String The ID of the VPN gateway instance.
    CustomerGatewayId String Customer gateway instance ID.
    PreShareKey String The pre-shared key.
    VpnProto String Tunnel transmission protocol.
    EncryptProto String Tunnel encryption protocol.
    RouteType String Route Type.
    CreatedTime Timestamp Creation Time.
    State String Production status of the tunnel. PENDING: Creating; AVAILABLE: Running; DELETING: Deleting.
    NetStatus String Connection status of the tunnel. AVAILABLE: Connected.
    SecurityPolicyDatabaseSet Array of SecurityPolicyDatabase SPD.
    IKEOptionsSpecification IKEOptionsSpecification IKE options.
    IPSECOptionsSpecification IPSECOptionsSpecification IPSEC options.

    VpnGateway

    VPN gateway object.

    Used by actions: CreateVpnGateway、DescribeVpnGateways.

    Name Type Description
    VpnGatewayId String Gateway instance ID.
    VpcId String VPC instance ID.
    VpnGatewayName String Gateway instance name.
    Type String Gateway instance type: 'IPSEC' and 'SSL'.
    State String Gateway instance status. 'PENDING': Creating; 'DELETING': Deleting; 'AVAILABLE': Running.
    PublicIpAddress String Gateway public IP.
    RenewFlag String Gateway renewal type: 'NOTIFY_AND_MANUAL_RENEW': Manual renewal. 'NOTIFY_AND_AUTO_RENEW': Automatic renewal. 'NOT_NOTIFY_AND_NOT_RENEW': No renewal after expiration.
    InstanceChargeType String Gateway billing type: POSTPAID_BY_HOUR: Postpaid by hour; PREPAID: Prepaid.
    InternetMaxBandwidthOut Integer Outbound bandwidth of gateway.
    CreatedTime Timestamp Creation Time.
    ExpiredTime Timestamp Expiration time of the prepaid gateway.
    IsAddressBlocked Boolean Whether the public IP is blocked.
    NewPurchasePlan String Change of billing method. PREPAID_TO_POSTPAID: Monthly subscription prepaid to postpaid by hour.
    RestrictState String Gateway billing status. PROTECTIVELY_ISOLATED: Instance is isolated; NORMAL: Normal.
    Zone String The availability zone, such as ap-guangzhou-2
    VpnGatewayQuotaSet Array of VpnGatewayQuota Gateway bandwidth quota information.

    VpnGatewayQuota

    VPN gateway quota object

    Used by actions: CreateVpnGateway、DescribeVpnGateways.

    Name Type Description
    Bandwidth Integer The bandwidth quota.
    Cname String The bandwidth quota name in Chinese.
    Name String The bandwidth quota name in English.