Tenant Cloud Network Virtual Private Cloud Data structure

Data structure

Last Updated At: 2026-08-02 00:06:22

LocalDestinationIpPortTranslationNatRule

Local Destination IP Port Translation Complex Structure

Referenced by the following interfaces: CreateLocalDestinationIpPortTranslationNatRule, DeleteLocalDestinationIpPortTranslationNatRule, DescribeLocalDestinationIpPortTranslationNatRules

name required NULL allowed type description
Protocol yes no String Protocol
Example: tcp
OriginalPort yes no Int64 Source Port
Example: 80
OriginalIp yes no String Source IP
Example: 10.0.0.5
TranslationPort yes no Int64 Destination port
Example: 80
TranslationIp yes no String Destination IP
Example: 2.2.2.2
Description no no String Description
Example: for_demo

Price

Price

Referenced by the following interfaces: InquiryPriceCreateVpcPeerConnection, InquiryPriceCreateVpnGateway, InquiryPriceNatGateway, InquiryPriceResetVpnGatewayInternetMaxBandwidth

name required NULL allowed type description
InstancePrice no no ItemPrice Instance price.
Example:View
BandwidthPrice no no ItemPrice Network price.
Example:View

VpcExtendCidr

VPC Expansion CIDR

Referenced by the following interfaces: DescribeVpcExtendCidrs

name required NULL allowed type description
VpcId yes no String VpcId
Example: vpc-67wlqf6v
CidrBlock yes no String CIDR
Example: 192.241.0.0/24
CreateTime yes no Date Creation Time
Example: 2018-06-21 11:32:29

VpcGateway

Gateway Information under VPC

Referenced by the following interfaces: DescribeVpcGateways

name required NULL allowed type description
SubnetId yes no String Subnet instance ID.
Example: subnet-8qywqc4y
Pip yes no String Private IP address.
Example: 10.12.2.12
WanIp yes no String Public IP address.
Example: 10.12.2.12

DirectConnectGateway

Direct Connect gateway object.

Referenced by the following interfaces: CreateDirectConnectGateway, DescribeDirectConnectGateways

name required NULL allowed type description
DirectConnectGatewayId yes no String Direct Connect gateway ID.
Example: dcg-e6mxyyvj
DirectConnectGatewayName yes no String Direct Connect gateway name.
Example: demo
VpcId yes no String Direct Connect gateway association with VPC instance ID.
Example: vpc-hm2okght
NetworkType yes no String Associated network type:
  • VPC - Virtual Private Cloud
  • CCN - Cloud Connect Network.

    • Example: CCN
    NetworkInstanceId yes no String Associated network instance ID: 
  • When NetworkType is VPC, this is the VPC instance ID.
  • When NetworkType is CCN, this is the CCN instance ID.

    • Example: ccn-4rukgymd
    GatewayType yes no String Gateway type:
  • NORMAL - Standard type, note: CCN supports only the Standard type
  • NAT - NAT type
    • NAT type supports network address translation configuration. Once the type is set, it cannot be changed. A VPC can create 1 NAT type Direct Connect gateway and 1 non-NAT type Direct Connect gateway.
    Example: NORMAL
    CreateTime yes no Datetime Creation time.
    Example: 2020-02-01 12:00:00
    DirectConnectGatewayIp yes no String Direct Connect gateway IP.
    Example: 10.212.253.59
    CcnId yes no String Associated CCN instance ID of Direct Connect gateway.
    Example: ccn-4rukgymd
    CcnRouteType yes no String CCN route learning type:
  • BGP - Automatic learning.
  • STATIC - Static, i.e., user configured.

    • Example: BGP
    EnableBGP yes no Bool Whether to enable BGP.
    Example: true
    EnableBGPCommunity no no Bool Attribute of Community enabling and disabling the BGP.
    Example: false
    Bandwidth no no Int64 Direct Connect gateway bandwidth speed limit value.
    Example: 100
    ModeType no no String Whether it supports releasing to CCN.
    Example: standard
    BGPCommunitySupport no no Bool Whether it supports BGP community attribute.
    Example: true
    VXLANSupport no yes Bool Whether VXLAN is supported.
    Example: true
    LocalZone no no Bool Whether it is a local region.
    Example: false
    BGPSupport no no Bool Whether BGP is supported.
    Example: true
    TagSet no no Array of Tag Tag Information
    Example:View
    AliasType no yes String Alias type.
    Example: NORMAL
    Ipv6Mode no no Bool Whether it is an IPv6 gateway.
    Example: true
    FlowDetailsUpdateTime no yes String Update time for streaming log information.
    Example: 2021-07-08 14:47:49
    AccessNetworkType no no String Backbone network type.
    Example: MPLS
    FlowLogId no yes String Unique ID of Flow Log
    Example: fl-7zvyvr8d
    DirectConnectGatewayVersion no yes String Direct Connect (DC) gateway version number.
    Example: V1
    AliasInstanceId no yes String Alias instance ID of the DC gateway, which is used in conjunction with AliasType.
    Example: 5gcg-12345678
    EnableFlowDetails no no Int64 Whether to enable traffic statistics.
    Example: 0
    NewAfc no no Int64 Marks whether the new AFC architecture is used for the DC gateway.
    Example: 0

    LocalSourceIpPortTranslationAclRule

    Local Source IP Port Translation ACL Mapping Rules

    Referenced by the following interfaces: CreateLocalSourceIpPortTranslationAclRule, DescribeLocalSourceIpPortTranslationAclRules

    name required NULL allowed type description
    Protocol yes no String Protocol
    Example: tcp
    SourceCidr yes no String Source Address
    Example: 1.1.1.0/16
    SourcePort yes no String Source Port
    Example: 80
    DestinationCidr yes no String Destination address
    Example: 2.2.2.0/16
    DestinationPort yes no String Destination port
    Example: 80
    Action no no Int64 Action. 0: Allow, 1: Reject.
    Example: 0
    AclRuleId no no Int64 ACL Rule ID
    Example: 26

    BandwidthLimitForCcnAlarmOnly

    CCN Regional Outbound Bandwidth Limit

    Referenced by the following interfaces: BandwidthLimitForCcnAlarmOnly

    name required NULL allowed type description
    Region yes no String Region. For example, ap-region.
    Example: region
    BandwidthLimit yes no Uint64 Outbound bandwidth cap, in Mbps.
    Example: 100
    VbcId yes no Uint64 Integer ID.
    Example: 65535
    CcnId yes no String Instance ID.
    Example: ccn-245ecr35

    ConflictItem

    Conflicting resource entry information.

    Referenced by the following interfaces: CheckAssistantCidr

    name required NULL allowed type description
    ConfilctId yes no String ID of the Conflicting Resource
    Example: rti-kngiybxl
    DestinationItem yes no String Conflicting Destination Resources
    Example: 10.0.0.0/24

    CcnRoute

    CCN Routing Policy Object

    Referenced by the following interfaces: DescribeCcnRoutes

    name required NULL allowed type description
    RouteId no no String Routing Policy ID
    Example: ccnr-hs2yc3ha
    DestinationCidrBlock yes no String Destination
    Example: 10.1.19.0/24
    InstanceType yes no String Type of next hop (associated instance type). All types include VPC and DIRECTCONNECT.
    Example: VPC
    InstanceId yes no String Next hop (associated instance)
    Example: vpc-fc21z82c
    InstanceName yes no String Next Hop Name (Associated Instance Name)
    Example: demo
    InstanceRegion yes no String Region of next hop (associated instance region)
    Example: region
    UpdateTime yes no Datetime Update time
    Example: 2022-11-19 15:20:25
    Enabled yes no Bool Whether route is enabled.
    Example: True
    InstanceUin yes no String Associated Instance UIN (Root Account)
    Example: 100000072292

    DfwOssGetUSGFromVMRequest

    Complex type: DfwOssGetUSGFromVMRequest.

    Referenced by the following interfaces: DescribeVmPolicyInternal

    name required NULL allowed type description
    Uuid no no String Name of the original DFW API (v2): getVMPolicy.uuid.
    Example: 84f9a2ad-6659-4864-808c-bd17f3c2acea

    DfwOssVMPolicy

    Complex type: DfwOssVMPolicy.

    Referenced by the following interfaces: DescribeVmPolicyInternal

    name required NULL allowed type description
    Policy no no Array of DfwOssPolicies Name of the original DFW API (v2): getVMPolicy.policy.
    Example:View
    IsolateLevel no no Int64 Name of the original DFW API (v2): getVMPolicy.isolateLevel.
    Example: 0
    Uuid no no String Name of the original DFW API (v2): getVMPolicy.uuid.
    Example: 84f9a2ad-6659-4864-808c-bd17f3c2acea
    ErrorCode no no Int64 Name of the original DFW API (v2): getVMPolicy.errorCode.
    Example: 0

    Filter

    Filter

    Referenced by the following interfaces: BandwidthLimitForCcnAlarmOnly, DescribeAddressTemplateGroups, DescribeAddressTemplates, DescribeAddresses, DescribeAssistantCidr, DescribeCcnAttachedInstances, DescribeCcnLimits, DescribeCcnRoutes, DescribeCustomerGateways, DescribeDBInstancesWithSecurityGroup, DescribeDirectConnectGateways, DescribeEipStatistics, DescribeHaVips, DescribeIp6Addresses, DescribeIp6Translators, DescribeLocalDestinationIpPortTranslationNatRules, DescribeLocalGateway, DescribeLocalIpTranslationAclRules, DescribeLocalIpTranslationNatRules, DescribeLocalSourceIpPortTranslationAclRules, DescribeLocalSourceIpPortTranslationNatRules, DescribeNatGatewayDestinationIpPortTranslationNatRules, DescribeNatGateways, DescribeNetDetectStates, DescribeNetDetects, DescribeNetworkAcls, DescribeNetworkInterfaces, DescribeNetworkInterfacesEx, DescribeNetworkInterfacesExtra, DescribePeerIpTranslationNatRules, DescribeRouteTables, DescribeRoutes, DescribeRoutesWithLocal, DescribeSecurityGroupPolicies, DescribeSecurityGroups, DescribeServiceInternal, DescribeServiceTemplateGroups, DescribeServiceTemplates, DescribeSubnets, DescribeTrafficMirrors, DescribeUsedIpAddress, DescribeVpcEndPoint, DescribeVpcEndPointService, DescribeVpcEndPointServiceWhiteList, DescribeVpcInstances, DescribeVpcInternal, DescribeVpcPeeringConnections, DescribeVpcs, DescribeVpnConnections, DescribeVpnGatewaySSLClients, DescribeVpnGatewaySSLServers, GetCcnRegionBandwidthLimits

    name required NULL allowed type description
    Name yes no String Attribute name. When there are multiple Filters, the relationship between Filters is logical AND.
    Example: tag-key
    Values yes no Array of String Attribute value. If a filter has multiple values, the relationship among the values under the same filter is logical OR (OR). When the value type is boolean, it can be directly set to the string "TRUE" or "FALSE".
    Example: ["TagKeyA", "TagKeyB"]

    NetworkInterface

    ENI

    Referenced by the following interfaces: CreateAndAttachNetworkInterface, CreateNetworkInterface, DescribeNetworkInterfaces, DescribeNetworkInterfacesEx, DescribeNetworkInterfacesExtra

    name required NULL allowed type description
    NetworkInterfaceId yes no String ENI instance ID, e.g., eni-f1xjkw1b.
    Example: eni-b4ax8qbz
    NetworkInterfaceName yes no String ENI name.
    Example: demo
    NetworkInterfaceDescription no no String ENI description.
    Example: demo
    SubnetId yes no String Subnet instance ID.
    Example: subnet-l0ykcjvi 
    VpcId yes no String VPC instance ID.
    Example: vpc-29mdigub
    GroupSet no no Array of String Security group bound.
    Example: sg-2edhcclz
    Primary no no Bool Whether it is the primary network interface.
    Example: true
    MacAddress yes no String MAC address.
    Example: 20:90:6F:EE:57:E2
    State yes no String ENI status:
  • PENDING: Creating
  • AVAILABLE: Available
  • ATTACHING: Attaching
  • DETACHING: Detaching
  • DELETING: Deleting.

    • Example: AVAILABLE
    PrivateIpAddressSet yes no Array of PrivateIpAddressSpecification Private IP information.
    Example:View
    Attachment no yes NetworkInterfaceAttachment Bound CVM object.
    Example:View
    Zone no no String Availability zone.
    Example: region
    CreatedTime no no String Creation time.
    Example: 2020-10-28 08:23:59
    Ipv6AddressSet yes no Array of Ipv6Address IPv6 address list.
    Example:View
    TagSet yes no Array of Tag Tag key-value pairs.
    Example:View
    EniType no no Uint64 Network interface types: 0 - ENI; 1 - EVM ENI.
    Example: 0
    FlowLogsSet no yes Array of FlowLog Stream log list.
    Example:View
    QosLevel no no String QoS Level
    Example: AG
    AttachType no no Uint64 Binding Level
    Example: 0
    Business no no String Business Party
    Example: TKE
    CdcId no no String Unique ID of CDC
    Example: cluster-gbo27yc4
    SubNetworkInterfaces no no Array of String List of relay ENI instances associated with this ENI.
    Example: ["eni-pq9vxykj"]
    Region no no String Region.
    Example: sz
    DeleteOnTermination no no Bool Whether to terminate the ENI when an instance is deleted.
    Example: true
    FlushSubEniHavipFlag no no Bool Whether to migrate zi wang kahavip.
    Example: true
    ResourceId no no String The resource ID for retaining the primary IP address of the ENI. It is used as an input parameter when the ENI is deleted.
    Example: cls-j85c20d4-reserved
    InstanceId no no String Cloud host instance ID.
    Example: ins-20113wki
    taskId no no Int64 Des task taskId
    Example: 213415

    RouteTable

    Route Table Object

    Referenced by the following interfaces: CreateIpv6Routes, CreateRouteTable, CreateRoutes, DescribeRouteTables

    name required NULL allowed type description
    VpcId yes no String VPC instance ID.
    Example: vpc-m0c2kcun
    RouteTableId yes no String Route table instance ID, e.g., rtb-azd4dt1c.
    Example: rtb-32kbqgtm
    RouteTableName yes no String Route table name.
    Example: ruby
    AssociationSet yes no Array of RouteTableAssociation Route Table Association.
    Example:View
    RouteSet yes no Array of Route Route table policy set.
    Example:View
    Main yes no Bool Whether it is a default route table.
    Example: True
    CreatedTime no no String Creation time.
    Example: 2010-11-21
    TagSet no no Array of Tag Tag key-value pairs.
    Example:View
    SubnetNum no yes Uint64 Subnet Count
    Example: 4
    Region no no String Region.
    Example: sz
    LocalCidrBlocks no no String Local routing.
    Example: 10.0.0.0/16

    NetDetectIpState

    Validation result for network probe destination IP.

    Referenced by the following interfaces: CheckNetDetectState, DescribeNetDetectStates

    name required NULL allowed type description
    DetectDestinationIp yes no String Probe destination IPv4 address.
    Example: ['1.1.1.3', '1.1.1.8']
    State yes no Int64 Probe results.
    0: Succeeded;
    -1: Route packet loss query failed;
    -2: Outgoing ACL packet loss;
    -3: Inbound ACL packet loss;
    -4: Other errors.
    Example: 0
    Delay yes no Uint64 Latency, in milliseconds.
    Example: 0
    PacketLossRate yes no Uint64 Packet Loss Rate
    Example: 0

    AddressTemplate

    IP address template

    Referenced by the following interfaces: CreateAddressTemplate, DescribeAddressTemplates

    name required NULL allowed type description
    AddressTemplateName yes no String IP address template name.
    Example: name
    AddressTemplateId yes no String Unique ID of IP address template instance.
    Example: ipm-3iv46d0c
    AddressSet yes no Array of String IP address information.
    Example: ["2.2.2.2"]
    CreatedTime no no String Creation time.
    Example: 2021-03-02 14:41:15

    EndPointService

    Endpoint service object.

    Referenced by the following interfaces: CreateVpcEndPointService, DescribeVpcEndPointService

    name required NULL allowed type description
    EndPointServiceId yes no String Endpoint Service ID
    Example: vpcsvc-demoag78
    VpcId yes no String VPCID.
    Example: vpc-gjui0b5t
    ServiceOwner yes no String APPID.
    Example: 251007979
    ServiceName yes no String Endpoint service name.
    Example: demo
    ServiceVip yes no String VIP of backend service.
    Example: 10.1.1.1
    ServiceInstanceId yes no String Backend service ID, e.g., lb-xxx.
    Example: lb-was1d32s
    AutoAcceptFlag yes no Bool Whether it is auto-accepted.
    Example: True
    EndPointCount yes yes Uint64 Number of associated endpoints.
    Example: 0
    EndPointSet yes yes Array of EndPoint Endpoint object array.
    Example:View
    CreateTime yes no String Creation time.
    Example: 2018-06-21 11:32:29
    IpAddressType no no String Address Type
    Example: IPv4/IPv6

    LocalGateway

    Local gateway information.

    Referenced by the following interfaces: CreateLocalGateway, DescribeLocalGateway

    name required NULL allowed type description
    CreateTime yes no String Local gateway creation time
    Example: 2021-03-24 15:31:56
    CdcId yes no String CDC instance ID
    Example: cluster-gbo27yc4
    VpcId yes no String VPC Instance ID
    Example: vpc-m0c2kcun
    UniqLocalGwId yes no String Local gateway instance ID
    Example: lgw-jkt4erty
    LocalGatewayName yes no String Local gateway name
    Example: demo
    LocalGwIp yes no String Local gateway IP address
    Example: 192.168.15.55

    VpcOssOverlap

    Complex type: VpcOssOverlap.

    Referenced by the following interfaces: CheckRoutingTableRouteSubnetOverlapInternal

    name required NULL allowed type description
    VpcId no no Int64 Integer VPCID.
    Example: 6
    UniqueVpcGatewayIndex no no String Name of the original VPC OSS API (v2): CheckRtbRouteSubnetOverlap.uniqVgwIndex.
    Example: pcx-qjtzxwhm
    Mask no no String Mask
    Example: 255.255.0.0
    RoutingTableId no no Int64 Name of the original VPC OSS API (v2): CheckRtbRouteSubnetOverlap.rtbId.
    Example: 29
    UniqueRoutingTableId no no String Name of the original VPC OSS API (v2): CheckRtbRouteSubnetOverlap.uniqRtbId.
    Example: rtb-o9u877nw
    Name no no String Name
    Example: testss2
    UniqueVpcId no no String The externally unique VPCID.
    Example: vpc-pe0kssdp
    VirtualGatewayType no no Int64 Name of the original VPC OSS API (v2): CheckRtbRouteSubnetOverlap.vgwType.
    Example: 4
    IntMask no no Int64 Integer mask.
    Example: 16
    VpcGatewayIndex no no String Name of the original VPC OSS API (v2): CheckRtbRouteSubnetOverlap.vgwIndex.
    Example: 19
    Owner no no String User app ID
    Example: toyacao
    Subnet no no String Subnet address
    Example: 10.2.0.0

    AclRuleId

    Local IP Translation ACL Rule ID Complex Type

    Referenced by the following interfaces: DeleteLocalIpTranslationAclRule

    name required NULL allowed type description
    RuleId yes no Int64 Rule ID
    Example: 5
    AclRuleId no no Int64 ACL Rule ID
    Example: 6

    DfwOssDelObjectsFromUSGRequest

    Complex type: DfwOssDelObjectsFromUSGRequest.

    Referenced by the following interfaces: DeleteObjectFromUSGInternal

    name required NULL allowed type description
    VIFS no no Array of String Name of the original VPC OSS API (v2): delObjectsFromUSG.vifs.
    Example: ['xxx']
    Services no no Array of String Name of the original VPC OSS API (v2): delObjectsFromUSG.svcs.
    Example: ['xxx']
    UsgId no no String Name of the original VPC OSS API (v2): delObjectsFromUSG.usgId.
    Example: sg-aosmqpxs
    Vms no no Array of String Name of the original VPC OSS API (v2): delObjectsFromUSG.vms.
    Example: ['84f9a2ad-6659-4864-808c-bd17f3c2acea']

    VpnGateway

    VPN gateway object.

    Referenced by the following interfaces: CreateVpnGateway, DescribeVpnGateways

    name required NULL allowed type description
    VpnGatewayId yes no String Gateway instance ID.
    Example: vpngw-az2xuzp5
    VpcId yes no String VPC instance ID.
    Example: vpc-qqa5rnd5
    VpnGatewayName yes no String Gateway instance name.
    Example: demo-gateway
    Type yes no String Gateway instance type: IPSEC, SSL, CCN.
    Example: IPSEC
    State yes no String Gateway instance status: 'PENDING' - pending production, 'DELETING' - Deleting, and 'AVAILABLE' - in operation.
    Example: AVAILABLE
    PublicIpAddress yes no String Public IP of gateway.
    Example: 139.124.3.2
    RenewFlag yes no String Gateway renewal type: 'NOTIFY_AND_MANUAL_RENEW' - manually renew, 'NOTIFY_AND_AUTO_RENEW' - automatically renew, 'NOT_NOTIFY_AND_NOT_RENEW' - not to renew upon expiration.
    Example: NOTIFY_AND_MANUAL_RENEW
    InstanceChargeType yes no String Gateway payment types: POSTPAID_BY_HOUR: postpaid by hour; PREPAID: prepaid by year/month.
    Example: POSTPAID_BY_HOUR
    InternetMaxBandwidthOut yes no Uint64 Outbound bandwidth of the gateway.
    Example: 5
    CreatedTime yes no Datetime Creation time.
    Example: 2021-04-25 17:14:34
    ExpiredTime yes no Datetime Expiration time of prepaid gateway.
    Example: 2021-04-25 17:14:34
    IsAddressBlocked yes no Bool Whether the public IP is blocked.
    Example: false
    NewPurchasePlan yes no String Billing mode change. PREPAID_TO_POSTPAID: prepaid by year/month to postpaid by hour.
    Example: PREPAID_TO_POSTPAID
    RestrictState yes no String Gateway billing state. PROTECTIVELY_ISOLATED: Instance that is securely isolated, NORMAL: Normal.
    Example: PROTECTIVELY_ISOLATED
    Zone yes no String Availability zone. For example, ap-region-2.
    Example: ap-region-2
    VpnGatewayQuotaSet yes no Array of VpnGatewayQuota Gateway Bandwidth Quota Information
    Example:View
    Version yes no String Gateway Instance Version Information
    Example: 1.0
    NetworkInstanceId yes no String When the value of Type is CCN, this value indicates CCN Instance ID.
    Example: ccn-gree226l
    IspType yes no String Public IP ISP
    Example: 5
    ProtocolType no no String Protocol type IPSEC/SSL.
    Example: IPSEC
    NetworkType no no String Network type. Currently, only VPC is supported.
    Example: VPC
    MaxConnection no no Uint64 The maximum connections.
    Example: 5
    CreateSSLServer no no Bool Whether the SSL server has been created.
    Example: true
    CdcId no yes String CDC instance ID.
    Example: cluster-gbo27yc4

    NatGatewayQuota

    NAT Gateway Quota

    Referenced by the following interfaces: DescribeNatGatewayQuota

    name required NULL allowed type description
    BandwidthQuota yes no Uint64 NAT Gateway Bandwidth Quota
    Example: 5000

    SourceIpTranslationNatRule

    SNAT Rules of NAT

    Referenced by the following interfaces: CreateNatGateway, CreateNatGatewaySourceIpTranslationNatRule, DescribeNatGatewaySourceIpTranslationNatRules, DescribeNatGateways, ModifyNatGatewaySourceIpTranslationNatRule

    name required NULL allowed type description
    NatGatewaySnatId no no String SNAT Rule ID
    Example: snat-3nptcfvp
    ResourceId yes no String Resource ID
    Example: subnet-7aed90al
    ResourceType yes yes String Resource type, currently including SUBNET and NETWORKINTERFACE.
    Example: SUBNET
    PrivateIpAddress yes no String Source IP/ IP Range
    Example: 172.168.100.0/24
    PublicIpAddresses yes no Array of String Elastic IP Address Pool
    Example: ['180.12.59.43']
    Description yes no String Description
    Example: demo
    NatGatewayId no yes String ID of NAT gateway.
    Example: nat-3nptcfvp
    VpcId no yes String VPC ID.
    Example: vpc-oty76xyl
    CreatedTime no yes String Creation time of NAT gateway SNAT rule.
    Example: 2021-03-14 13:59:00

    IpAddressStates

    Information on resources that occupy the IP addresses.

    Referenced by the following interfaces: DescribeUsedIpAddress

    name required NULL allowed type description
    ResourceType yes no String Resource Type
    Example: ENI
    ResourceId yes no String Resource ID
    Example: eni-bjekqff1
    VpcId yes no String VPC instance ID.
    Example: vpc-mcqaoy0f
    SubnetId yes no String Subnet instance ID.
    Example: subnet-j4oluywm
    IpAddress yes no String IP address.
    Example: 172.16.0.16

    Ipv6Address

    IPv6 address information.

    Referenced by the following interfaces: AssignIpv6Addresses, CreateAndAttachNetworkInterface, CreateNetworkInterface, DescribeNetworkInterfaces, DescribeNetworkInterfacesEx, DescribeNetworkInterfacesExtra, InquiryPriceAllocateIp6AddressesBandwidth, ModifyIpv6AddressesAttribute, UnassignIpv6Addresses

    name required NULL allowed type description
    Address yes no String IPv6 address, e.g., 3402:4e00:20:100:0:8cd9:2a67:71f3.
    Example: 2409:8c60:2501:1002:aebe:e74c:7a3c:3
    Primary no no Bool Whether it is the primary IP.
    Example: Ture
    AddressId no no String EIP instance ID, e.g., eip-hxlqja90.
    Example: eip-d97psd1o
    Description no no String Description information.
    Example: demo
    IsWanIpBlocked no no Bool Whether the public IP is blocked.
    Example: Ture
    State no no String IPv6 address status:
  • PENDING: Pending
  • MIGRATING: Migrating
  • DELETING: Deleting
  • AVAILABLE: Available.

    • Example: AVAILABLE

    VpcOssVpc

    Complex type: VpcOssVpc.

    Referenced by the following interfaces: DescribeVpcAndSubnetInternal

    name required NULL allowed type description
    Subnet no no String u5b50u7f51u5730u5740
    Example: 172.16.0.0
    SubnetSet no no Array of VpcOssSubnetForDescribeVpcAndSubnetInternal u539fVPC OSS APIv2u540du79f0: GetVpcAndSubnet.subnets
    Example:View
    VpcId no no Int64 u6574u6570vpcId
    Example: 78257
    IntMask no no Int64 u6574u6570u63a9u7801
    Example: 16
    OwnedFlag no no Int64 u662fu5426u81eau7814
    Example: 0
    DhcpFlag no no Int64 u539fVPC OSS APIv2u540du79f0: GetVpcAndSubnet.dhcpFlag
    Example: 1
    CreateTime no no String u539fVPC OSS APIv2u540du79f0: GetVpcAndSubnet.createTime
    Example: 2021-03-22 20:59:55
    Name no no String u540du79f0
    Example: Default-VPC
    UniqueVpcId no no String u5bf9u5916u552fu4e00VpcId
    Example: vpc-jmaywf6r
    DefaultFlag no no Int64 u539fVPC OSS APIv2u540du79f0: GetVpcAndSubnet.bDefault
    Example: 1
    BraceLinkFlag no no Int64 u539fVPC OSS APIv2u540du79f0: GetVpcAndSubnet.braceLinkFlag
    Example: 0
    OwnerLevel no no Int64 u539fVPC OSS APIv2u540du79f0: GetVpcAndSubnet.ownerLevel
    Example: -1
    Owner no no String u7528u6237AppId
    Example: 251198225

    VpcOssRouteWeightRequest

    Complex type: VpcOssRouteWeightRequest.

    Referenced by the following interfaces: UpdateRouteWeightInternal

    name required NULL allowed type description
    UniqueVpcId no no String The externally unique VPCID.
    Example: vpc-jmaywf6r
    GroupId no no Int64 Original VPC OSS APIv2 name: UpdateRouteWeight.groupId.
    Example: 1
    Protocol no no String Original VPC OSS APIv2 name: UpdateRouteWeight.proto.
    Example: tcp
    Vip no no String Original VPC OSS APIv2 name: UpdateRouteWeight.vip.
    Example: 172.16.0.18
    VirtualPort no no Int64 Original VPC OSS APIv2 name: UpdateRouteWeight.vport.
    Example: 22
    RouteSet no no Array of VpcOssRouteForUpdateRouteWeightInternal Original VPC OSS APIv2 name: UpdateRouteWeight.route.
    Example:View
    VpcId no no Int64 Integer VPCID.
    Example: 1

    InstanceChargePrepaid

    Prepaid (Monthly Subscription) billing object.

    Referenced by the following interfaces: CreateVpnGateway, InquiryPriceCreateVpnGateway

    name required NULL allowed type description
    Period yes no Uint64 Purchased instance duration, in months. Value range: 1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, 36.
    Example: 5
    RenewFlag no no String Auto-renewal flag. Value range: NOTIFY_AND_AUTO_RENEW: notify and auto-renew on expiration, NOTIFY_AND_MANUAL_RENEW: notify and do not auto-renew on expiration. Default: NOTIFY_AND_MANUAL_REVIEW.
    Example: NOTIFY_AND_AUTO_RENEW

    IpField

    Field Information for IP Online Query

    Referenced by the following interfaces: DescribeIpLocation, DescribeIpOnline

    name required NULL allowed type description
    Country no no Bool National Field Information
    Example: true
    Province no no Bool Administrative zone information at province, state, or county level.
    Example: true
    City no no Bool Field Information on Municipal Administrative Region
    Example: true
    Region no no Bool Urban zone field information
    Example: true
    Isp no no Bool Access ISP Field Information
    Example: true
    AsName no no Bool Backbone ISP Field Information
    Example: true
    AsId no no Bool Backbone AS Number
    Example: true
    Comment yes no Bool Comment Field
    Example: true

    Quota

    Description of Quota Information

    Referenced by the following interfaces: DescribeAddressActionQuota, DescribeAddressQuota, DescribeIp6TranslatorQuota

    name required NULL allowed type description
    QuotaId no no String Quota name. The values are
  • TOTAL_EIP_QUOTA: EIP quota count under the user's current region.
  • DAILY_EIP_APPLY: Number of subscriptions today under the user's current region.
  • DAILY_PUBLIC_IP_ASSIGN: Number of times a public IP is reassigned in the user's current region.
    Example: TOTAL_EIP_QUOTA
    		•
    QuotaCurrent no no Int64 Current quantity
    Example: 10
    QuotaLimit no no Int64 Quota
    Example: 10
    QuotaGroup no no String Regions where the quota takes effect.
    Example: sz

    VpcOssUpdatePeer

    Complex type: VpcOssUpdatePeer.

    Referenced by the following interfaces: UpdateVpcPeerInternal

    name required NULL allowed type description
    SrcVpcSubnet no no String Name of the original VPC OSS API (v2): UpdateVpcPeer.sVpcSubnet.
    Example: 172.16.0.0
    OldName no no String Name of the original VPC OSS API (v2): UpdateVpcPeer.oldName.
    Example: DDDD
    SrcVpcId no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.sVpcId.
    Example: 78257
    LocalBandwidth no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.localBandwidth.
    Example: 0
    OldDestVpcIntMask no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.oldDVpcIntMask.
    Example: 16
    OldSrcExpireTime no no String Name of the original VPC OSS API (v2): UpdateVpcPeer.oldSExpireTime.
    Example: 2021-12-31 19:41:49
    VirtualSafeGroupIp no no String Name of the original VPC OSS API (v2): UpdateVpcPeer.vsgIp.
    Example: 0.0.0.0
    DestViewFlag no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.dViewFlag.
    Example: 1
    OldState no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.oldState.
    Example: 1
    OwedFlag no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.owedFlag.
    Example: 0
    NewAfcFlag no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.bNewAfc.
    Example: 0
    OldWanOutLimit no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.oldWanOutLimit.
    Example: 0
    Type no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.type.
    Example: 0
    OldLastState no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.oldLastState.
    Example: 0
    OldVirtualSafeGroupIp no no String Name of the original VPC OSS API (v2): UpdateVpcPeer.oldVsgIp.
    Example: 0.0.0.0
    UniqueDestVpcId no no String Name of the original VPC OSS API (v2): UpdateVpcPeer.uniqDVpcId.
    Example: vpc-n05ss3vl
    SrcOwner no no String Name of the original VPC OSS API (v2): UpdateVpcPeer.sOwner.
    Example: 251198225
    State no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.state.
    Example: 1
    OldSrcVpcIntMask no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.oldSVpcIntMask.
    Example: 16
    UniqueSrcVpcId no no String Name of the original VPC OSS API (v2): UpdateVpcPeer.uniqSVpcId.
    Example: vpc-jmaywf6r
    DestVpcId no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.dVpcId.
    Example: 76644
    OldNewAfcFlag no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.oldBNewAfc.
    Example: 0
    DestVpcIntMask no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.dVpcIntMask.
    Example: 16
    OldSrcVpcSubnet no no String Name of the original VPC OSS API (v2): UpdateVpcPeer.oldSVpcSubnet.
    Example: 172.16.0.0
    DestRegion no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.dRegion.
    Example: 0
    OldDestViewFlag no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.oldDViewFlag.
    Example: 1
    SrcRegion no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.sRegion.
    Example: 0
    Bandwidth no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.bandwidth.
    Example: 0
    OldZoneVpcPeerFlag no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.oldBZoneVpcPeer.
    Example: 0
    OldOwedFlag no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.oldOwedFlag.
    Example: 0
    PublishDockerCidrFlag no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.bPublishDockerCidr.
    Example: 0
    OldDestVpcSubnet no no String Name of the original VPC OSS API (v2): UpdateVpcPeer.oldDVpcSubnet.
    Example: 10.0.0.0
    LastState no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.lastState.
    Example: 0
    SrcViewFlag no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.sViewFlag.
    Example: 1
    DestVpcSubnet no no String Name of the original VPC OSS API (v2): UpdateVpcPeer.dVpcSubnet.
    Example: 10.0.0.0
    CreateTime no no String Name of the original VPC OSS API (v2): UpdateVpcPeer.createTime.
    Example: 2021-12-31 19:41:49
    OldDestExpireTime no no String Name of the original VPC OSS API (v2): UpdateVpcPeer.oldDExpireTime.
    Example: 2021-12-31 19:41:49
    SrcExpireTime no no String Name of the original VPC OSS API (v2): UpdateVpcPeer.sExpireTime.
    Example: 2021-12-31 19:41:49
    VpcPeerId no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.vpcPeerId.
    Example: 26574
    Name no no String Name
    Example: DDDD
    UniqueVpcPeerId no no String Name of the original VPC OSS API (v2): UpdateVpcPeer.uniqVpcPeerId.
    Example: pcx-fh7xs34s
    SrcVpcIntMask no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.sVpcIntMask.
    Example: 16
    OldSrcViewFlag no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.oldSViewFlag.
    Example: 1
    DestExpireTime no no String Name of the original VPC OSS API (v2): UpdateVpcPeer.dExpireTime.
    Example: 2021-12-31 19:41:49
    DestOwner no no String Name of the original VPC OSS API (v2): UpdateVpcPeer.dOwner.
    Example: 251198225
    Owner no no String User app ID
    Example: 251198225
    OldLocalBandwidth no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.oldLocalBandwidth.
    Example: 0
    WanOutLimit no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.wanOutLimit.
    Example: 0
    ZoneVpcPeerFlag no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.bZoneVpcPeer.
    Example: 0
    NfvFlag no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.bNfv.
    Example: 0
    OldPublishDockerCidrFlag no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.oldBPublishDockerCidr.
    Example: 0
    OldBandwidth no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.oldBandwidth.
    Example: 0
    ImageId no no String Name of the original VPC OSS API (v2): UpdateVpcPeer.imageId.
    Example: xx
    AfcVpcPeerGlobalId no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.afcVpcPeerGlobalId.
    Example: 0

    IPSECOptionsSpecification

    IPSec session security settings.

    Referenced by the following interfaces: CreateVpnConnection, DescribeVpnConnections, ModifyVpnConnectionAttribute

    name required NULL allowed type description
    EncryptAlgorithm no no String Encryption algorithms. Options: '3DES-CBC', 'AES-CBC-128', 'AES-CBC-192', 'AES-CBC-256', 'DES-CBC', and 'NULL'. Default: AES-CBC-128.
    Example: AES-CBC-128
    IntegrityAlgorith no no String Authentication algorithm. Options: MD5, SHA1. The default is
    Example: SHA1
    IPSECSaLifetimeSeconds no no Uint64 IPsec SA lifetime (s): In seconds, range: 180-604,800
    Example: 180
    PfsDhGroup no no String PFS: options: 'NULL', 'DH-GROUP1', 'DH-GROUP2', 'DH-GROUP5', 'DH-GROUP14', and 'DH-GROUP24'. The default is NULL.
    Example: NULL
    IPSECSaLifetimeTraffic no no Uint64 IPsec SA lifetime (KB): In KB, range: 2,560-604,800.
    Example: 2560

    NatGatewayDestinationIpPortTranslationNatRule

    Port Forwarding Rules of NAT Gateway

    Referenced by the following interfaces: DescribeNatGatewayDestinationIpPortTranslationNatRules

    name required NULL allowed type description
    IpProtocol no no String IP, options: TCP and UDP.
    Example: TCP
    PublicIpAddress yes no String Elastic IP.
    Example: jkt.jkt.jkt.jkt
    PublicPort yes no Uint64 Public network port.
    Example: 443
    PrivateIpAddress yes no String Private network address.
    Example: 192.168.1.2
    PrivatePort yes no Uint64 VPC port.
    Example: 443
    Description no no String Description of NAT gateway forwarding rules.
    Example: Port forwarding example
    NatGatewayId yes yes String ID of NAT gateway.
    Example: nat-3isn9hr0
    VpcId yes yes String VPC ID.
    Example: vpc-rkzpefgh
    CreatedTime yes yes String Creation time of NAT gateway forwarding rule.
    Example: "2021-05-24 19:28:31"

    VpcPrivateIpAddress

    VPC private IP object.

    Referenced by the following interfaces: DescribeVpcPrivateIpAddresses

    name required NULL allowed type description
    PrivateIpAddress yes no String Private IP of VPC.
    Example: 192.168.12.3
    CidrBlock yes no String Subnet CIDR.
    Example: 192.241.0.0/24
    PrivateIpAddressType yes no String Private IP type.
    Example: CVM/ENI
    CreatedTime yes no Datetime IP application time.
    Example: 2020-06-06 10:00:00

    UsedDetailDownload

    Generation History of Traffic Package Usage Detail File

    Referenced by the following interfaces: DescribeDownloadSpecificTrafficPackageUsedDetails

    name required NULL allowed type description
    Id yes no Int64 Unique ID of Generation History
    Example: 5
    TrafficPackageId yes no String Unique ID of Traffic Package
    Example: tfp-f7a3qh6x
    StartTime yes no Datetime Start Time
    Example: 2021-10-10 10:00:00
    EndTime yes no Datetime End time
    Example: 2021-10-10 10:00:00
    DownloadUrl yes yes String Download link
    Example: https://ip-address-repo.cos.ap-region.mycloud.com
    Filename yes no String File name
    Example: cos
    Status yes no String Task status: RUNNING, SUCCESS, or FAIL.
    Example: RUNNING
    ErrorMsg yes yes String Error Message
    Example: time out
    ExpiredAt yes yes Datetime Download Link Expiration Time
    Example: 2021-10-10 10:00:00
    CreatedAt yes no Datetime File Generation Time
    Example: 2021-10-10 10:00:00
    IsExpired yes yes Bool Whether the download link has expired.
    Example: True

    VpcOssService

    Complex type: VpcOssService.

    Referenced by the following interfaces: DescribeServiceByRealServerInternal

    name required NULL allowed type description
    Protocol no no String Original VPC OSS APIv2 name: GetServiceByRs.proto.
    Example: tcp
    ResetFlag no no Int64 Original VPC OSS APIv2 name: GetServiceByRs.rstFlag.
    Example: 0
    StickyTimeout no no Int64 Original VPC OSS APIv2 name: GetServiceByRs.stickyTimeout.
    Example: 0
    GroupId no no Array of Int64 Original VPC OSS APIv2 name: GetServiceByRs.groupId.
    Example: [0]
    RemoteVpcId no no Int64 Original VPC OSS APIv2 name: GetServiceByRs.remoteVpcId.
    Example: 0
    SetId no no Int64 Original VPC OSS APIv2 name: GetServiceByRs.setId.
    Example: 0
    VpcId no no Int64 Integer VPCID.
    Example: 2598864
    UniqueVpcId no no String The externally unique VPCID.
    Example: vpc-rpufyveg
    Vip no no String Original VPC OSS APIv2 name: GetServiceByRs.vip.
    Example: 169.254.0.30
    StickyFlag no no Int64 Original VPC OSS APIv2 name: GetServiceByRs.stickyFlag.
    Example: 0
    UniqueVpcGatewayId no no String Original VPC OSS APIv2 name: GetServiceByRs.uniqVpcgwId.
    Example: vpcgw-7hk70tq8
    ToaHostIpFlag no no Int64 Original VPC OSS APIv2 name: GetServiceByRs.toaHostIpFlag.
    Example: 0
    NoSnatFlag no no Int64 Original VPC OSS APIv2 name: GetServiceByRs.noSnatFlag.
    Example: 0
    HealthFlag no no Int64 Original VPC OSS APIv2 name: GetServiceByRs.healthFlag.
    Example: 1
    Business no no String Original VPC OSS APIv2 name: GetServiceByRs.business.
    Example: dockerMaster
    RouteSet no no Array of VpcOssRoute Original VPC OSS APIv2 name: GetServiceByRs.route.
    Example:View
    StickyMaxCount no no Int64 Original VPC OSS APIv2 name: GetServiceByRs.stickyMaxCount.
    Example: 0
    VipVpcGatewayId no no String Original VPC OSS APIv2 name: GetServiceByRs.uniqVpcGwIpVpcgwId.
    Example: vpcgw-7hk7255d
    VirtualPort no no Int64 Original VPC OSS APIv2 name: GetServiceByRs.vport.
    Example: 443
    BypassFlag no no Int64 Original VPC OSS APIv2 name: GetServiceByRs.bypassFlag.
    Example: 0
    Type no no Int64 Original VPC OSS APIv2 name: GetServiceByRs.type.
    Example: 1
    SubnetRouteAlgorithm no no Int64 Original VPC OSS APIv2 name: GetServiceByRs.subnetRouteAlgorithm.
    Example: 0
    VipSetId no no Int64 Original VPC OSS APIv2 name: GetServiceByRs.vipSetId.
    Example: 0
    UniqueClassicVpcGatewayId no no String Original VPC OSS APIv2 name: GetServiceByRs.uniqClassicVpcgwId.
    Example: vpcgw-7hk70tq8
    VpcGatewayIp no no String Original VPC OSS APIv2 name: GetServiceByRs.vpcGwIp.
    Example: 9.105.119.10
    LbType no no Int64 Original VPC OSS APIv2 name: GetServiceByRs.lbType.
    Example:
    RouteType no no String Service routing type. 0: The RS is in the current VPC; 1: The RS is in a physical network; 3: The RS is in another VPC.
    Example:

    CcnBandwidthInfo

    Information Describing CCN Inter-Region Speed Limited Bandwidth Instance

    Referenced by the following interfaces: GetCcnRegionBandwidthLimits

    name required NULL allowed type description
    CcnId yes yes String CCN ID of the bandwidth.
    Example: ccn-ef5nufih
    CreatedTime yes yes String Instance creation time.
    Example: 2018-12-18 20:11:37
    ExpiredTime yes yes String Instance Expiration Time
    Example: 2019-01-18 20:11:37
    RegionFlowControlId yes yes String Unique ID of bandwidth instance.
    Example: fcr-6fda09za
    RenewFlag yes yes String Flag of whether the bandwidth is auto-renewed.
    Example: NOTIFY_AND_AUTO_RENEW
    CcnRegionBandwidthLimit yes yes CcnRegionBandwidthLimit Describe the bandwidth region and the speed limit information.
    Example:View

    AlgType

    ALG Protocol Type

    Referenced by the following interfaces: DescribeAddresses, DescribeIp6Addresses

    name required NULL allowed type description
    Ftp yes no Bool Whether the FTP protocol ALG feature is enabled.
    Example: Ture
    Sip yes no Bool Whether the SIP Protocol ALG feature is enabled.
    Example: Ture

    ModifyBandwidthPrice

    Adjust bandwidth inquiry result.

    Referenced by the following interfaces: InquiryPriceModifyAddressesBandwidth

    name required NULL allowed type description
    AddressPrice no no AddressPrice Adjust bandwidth inquiry result.
    Example:View

    VpcNum

    Numeric ID of VPC

    Referenced by the following interfaces: DescribeVpcIds

    name required NULL allowed type description
    VpcId yes no String VPC instance ID.
    Example: vpc-napeigw5
    VpcNumId yes no Uint64 Numeric ID of VPC instance.
    Example: 67087

    CcnAttachedInstance

    CCN Associated Instance Object

    Referenced by the following interfaces: DescribeCcnAttachedInstances

    name required NULL allowed type description
    CcnId yes no String CCN instance ID.
    Example: ccn-31zf3vib
    InstanceType yes no String Associated instance type:
  • VPC: Virtual Private Cloud
  • DIRECTCONNECT: Direct Connect gateway
  • BMVPC: BM VPC.

    • Example: VPC
    InstanceId yes no String Associated instance ID.
    Example: vpc-lt6ork07
    InstanceName yes no String Associated instance name.
    Example: demo
    InstanceRegion yes no String Region of the associated instance. For example, ap-region.
    Example: ap-region
    InstanceUin yes no String Associated instance UIN (root account).
    Example: 100000072292
    CidrBlock yes no Array of String Associated instance CIDR.
    Example: 10.1.0.0/16
    State yes no String Associated instance status:
  • PENDING: Applying
  • ACTIVE: Connected
  • EXPIRED: Expired
  • REJECTED: Rejected
  • DELETED: Deleted
  • FAILED: Failed (will be forcefully detached asynchronously after 2 hours)
  • ATTACHING: Attaching
  • DETACHING: Detaching
  • DETACHFAILED: Detaching failed (will be forcefully detached asynchronously after 2 hours).

    • Example: ACTIVE
    AttachedTime yes no Datetime Association time.
    Example: 2021-03-03 16:19:44
    CcnUin yes no String UIN of CCN (root account).
    Example: 100000072292

    VpcOssNatServiceRequestForCreateNatGatewayServiceInternal

    Complex type: VpcOssNatServiceRequestForCreateNatGatewayServiceInternal.

    Referenced by the following interfaces: CreateNatGatewayServiceInternal

    name required NULL allowed type description
    Business no no String Name of the original VPC OSS API (v2): AddNatgwService.business.
    Example: xxx
    BusinessOwner no no String Name of the original VPC OSS API (v2): AddNatgwService.businessOwner.
    Example: xxx
    VpcGatewayIndex no no String Name of the original VPC OSS API (v2): AddNatgwService.vgwIndex.
    Example: xxx
    Count no no Int64 Name of the original VPC OSS API (v2): AddNatgwService.count.
    Example: 10
    VirtualPort no no Int64 Name of the original VPC OSS API (v2): AddNatgwService.vport.
    Example: 111
    SkipCheckPrivateIpDatabaseFlag no no Int64 Name of the original VPC OSS API (v2): AddNatgwService.bSkipCheckPipDb.
    Example: 0
    GwType no no Int64 JNSGW type. Valid values: 0 and 1.
    Example: 0
    ProtocolPort no no Int64 Name of the original VPC OSS API (v2): AddNatgwService.pport.
    Example: 554
    GatewayIp no no String Name of the original VPC OSS API (v2): AddNatgwService.gwIp.
    Example: 1.1.1.1
    IpType no no Uint64 ipType value applied for by the service from VPC OSS.
    Example: 10
    Protocol no no String Name of the original VPC OSS API (v2): AddNatgwService.proto.
    Example: tcp
    PrivateIp no no String Name of the original VPC OSS API (v2): AddNatgwService.pip.
    Example: 172.16.0.18
    Bandwidth no no Int64 Name of the original VPC OSS API (v2): AddNatgwService.bandwidth.
    Example: 10
    VpcId no no Int64 Integer VPCID.
    Example: 123
    UniqueVpcId no no String The externally unique VPCID.
    Example: vpc-jmaywf6r
    Owner yes no String User app ID
    Example: 251198225
    VirtualGatewayType no no Int64 Name of the original VPC OSS API (v2): AddNatgwService.vgwType
    Example: 0
    UniqueVpcGatewayIndex no no String Name of the original VPC OSS API (v2): AddNatgwService.uniqVgwIndex.
    Example: xxx
    SubnetId no no Int64 Integer subnetId.
    Example: 123

    SubnetNum

    Numeric ID of Subnet

    Referenced by the following interfaces: DescribeSubnetIds

    name required NULL allowed type description
    VpcId yes no String VPC instance ID.
    Example: vpc-demoag78
    VpcNumId yes no Uint64 Numeric ID of VPC instance.
    Example: 10
    SubnetId yes no String Subnet instance ID.
    Example: subnet-demoag78
    SubnetNumId yes no Uint64 Numeric ID of the subnet instance.
    Example: 4643
    SubnetName no no String Subnet name, up to 60 bytes in length.
    Example: 4643

    VpcOssSubnetForDescribeVpcAndSubnetInternal

    Complex type: VpcOssSubnetForDescribeVpcAndSubnetInternal.

    Referenced by the following interfaces: DescribeVpcAndSubnetInternal

    name required NULL allowed type description
    Subnet no no String Subnet address
    Example: 172.16.0.0
    Name no no String Name
    Example: Default-Subnet
    ZoneId no no Int64 Name of the original VPC OSS API (v2): GetVpcAndSubnet.zoneId.
    Example: 100002
    UniqueSubnetId no no String The externally unique SubnetId.
    Example: subnet-dbrazzr0
    IntMask no no Int64 Integer mask.
    Example: 20
    CreateTime no no String Name of the original VPC OSS API (v2): GetVpcAndSubnet.createTime.
    Example: 2021-03-22 20:59:55
    DefaultFlag no no Int64 Name of the original VPC OSS API (v2): GetVpcAndSubnet.bDefault.
    Example: 1
    SubnetId no no Int64 Integer subnetId.
    Example: 1990867
    DhcpFlag no no Int64 Name of the original VPC OSS API (v2): GetVpcAndSubnet.dhcpFlag.
    Example: 0

    AddressLibInfo

    IP Address Library Information

    Referenced by the following interfaces: DescribeIpLocation, DescribeIpOnline

    name required NULL allowed type description
    Country yes no String Country Information
    Example: UK
    Province yes no String Information of Administrative Zone at Province, State, or County Level
    Example: ap-region
    City yes no String Municipal Administrative Region Information
    Example: ap-region
    Region yes no String Urban Region Information
    Example: ap-region
    Isp yes no String Access ISP Information
    Example: BGP
    AddressIp yes no String Query IP Address
    Example: 10.21.3.2
    AsName yes no String Backbone ISP Information
    Example: CTCC
    AsId yes no String ISP AS Number
    Example: CTCC
    Comment yes no String Comment information. The currently filled value is the APN value of mobile access users. If there is no APN attribute, it will be empty.
    Example: demo
    InternetServiceProvider yes no String Same ISP, deprecated.
    Example: BGP

    NetworkAclEntrySet

    Network ACL Rule Collection

    Referenced by the following interfaces: ModifyNetworkAclEntries

    name required NULL allowed type description
    Ingress no no Array of NetworkAclEntry Inbound rules.
    Example:View
    Egress no no Array of NetworkAclEntry Outbound rules.
    Example:View

    GatewayQos

    Gateway Traffic Control Bandwidth Information

    Referenced by the following interfaces: DescribeGatewayFlowQos

    name required NULL allowed type description
    VpcId yes no String VPC instance ID.
    Example: vpc-67wlqf6v
    IpAddress yes no String Private IP of CVM.
    Example: 192.168.3.23
    Bandwidth yes no Uint64 Traffic control bandwidth value.
    Example: 50
    CreateTime yes no String Creation time.
    Example: 2023-12-25 12:30:00

    TrafficMirror

    Traffic Mirror Instance

    Referenced by the following interfaces: CreateTrafficMirror, DescribeTrafficMirrors

    name required NULL allowed type description
    VpcId yes no String VPC Instance ID
    Example: vpc-7zayowkt
    TrafficMirrorId yes no String Traffic Mirror Instance
    Example: imgf-oc2mpbni
    TrafficMirrorName yes no String TrafficImageName
    Example: demo_vxlan
    TrafficMirrorDescribe yes no String Traffic Mirror Description
    Example: desc
    State yes no String Traffic Mirror Status
    Example: RUNNING
    Direction yes no String Traffic Mirror Collection Direction
    Example: ALL
    CollectorSrcs yes no Array of String Traffic Mirror Collection Object
    Example: ["vpc-7zayowkt"]
    NatId yes no String NAT Gateway Instance ID of Traffic Mirror Filter
    Example: ""
    CollectorNormalFilters yes no Array of TrafficMirrorFilter Quintuple Rules for Traffic Mirror Filter
    Example:View
    CollectorTarget yes no TrafficMirrorTarget Traffic mirror receiving target
    Example:View
    CreateTime yes no String Traffic Mirror Creation Time
    Example: 2021-03-02 14:41:15

    VpnGatewayQuota

    VPN Gateway Quota Object

    Referenced by the following interfaces: CreateVpnGateway, DescribeVpnGatewayQuota, DescribeVpnGateways

    name required NULL allowed type description
    Bandwidth yes no Uint64 Bandwidth Quota
    Example: 100
    Cname yes no String Name of Quota
    Example: Large
    Name yes no String Quota's English Name
    Example: newlarge

    DfwOssDeleteUSGRequest

    Complex type: DfwOssDeleteUSGRequest.

    Referenced by the following interfaces: DeleteUSGInternal

    name required NULL allowed type description
    UsgId no no String Name of the original DFW API (v2): deleteUSG.usgId.
    Example: 123123
    ProjectId no no String Name of the original DFW API (v2): deleteUSG.projectId.
    Example: 123

    DfwOssPolicies

    Complex type: DfwOssPolicies.

    Referenced by the following interfaces: AttachPolicyToVMInternal, DeletePolicyFromVmInternal, DescribeVmPolicyInternal

    name required NULL allowed type description
    Action no no String Name of the original DFW API (v2): delPolicyFromVM.action.
    Example: ACCEPT
    Ip no no String Name of the original DFW API (v2): delPolicyFromVM.ip.
    Example: 10.0.0.0/8
    Protocol no no String Name of the original DFW API (v2): delPolicyFromVM.protocol.
    Example: tcp
    Port no no String Name of the original DFW API (v2): delPolicyFromVM.port.
    Example: 80
    Direction no no String Name of the original DFW API (v2): delPolicyFromVM.direction.
    Example: INPUT

    PrivateIpAddressSpecification

    Private IP Information

    Referenced by the following interfaces: AssignPrivateIpAddresses, CreateAndAttachNetworkInterface, CreateNetworkInterface, CreateNetworkInterfaceEx, DescribeNetworkInterfaces, DescribeNetworkInterfacesEx, DescribeNetworkInterfacesExtra, ModifyPrivateIpAddressesAttribute, UnassignPrivateIpAddresses

    name required NULL allowed type description
    PrivateIpAddress yes no String Private IP address.
    Example: 192.168.0.10
    Primary no no Bool Whether it is the primary IP.
    Example: true
    PublicIpAddress no no String Public IP address.
    Example: jkt.10.100.171
    AddressId no no String EIP instance ID, such as eip-jrkzpvgt.
    Example: eip-29mdigub
    Description no no String Private IP description information.
    Example: demo
    IsWanIpBlocked no no Bool Whether the public IP is blocked.
    Example: true
    State no no String IP Status:
    PENDING: In production
    MIGRATING: Migrating
    DELETING: Deleting
    AVAILABLE: Available.
    Example: AVAILABLE

    DfwOssGetUSGCountFromSGRequest

    Complex type: DfwOssGetUSGCountFromSGRequest.

    Referenced by the following interfaces: DescribeUSGCountFromSgInternal, DescribeUSGQuotaInternal

    name required NULL allowed type description
    SgId no no String Name of the original DFW API (v2): getUSGQuota.sgId.
    Example: 132131231
    Project no no String Name of the original DFW API (v2): getUSGQuota.project.
    Example: 132131231

    NetDetectState

    Network probe verification result.

    Referenced by the following interfaces: DescribeNetDetectStates

    name required NULL allowed type description
    NetDetectId yes no String The network detection instance ID, such as netd-demoag78.
    Example: netd-7s4wt576
    NetDetectIpStateSet yes no Array of NetDetectIpState Validation result object array of the destination IP in network probe.
    Example:View

    NatGateway

    NAT gateway object.

    Referenced by the following interfaces: CreateNatGateway, DescribeNatGateways

    name required NULL allowed type description
    NatGatewayId yes no String ID of NAT gateway.
    Example: "nat-demoag78"
    NatGatewayName yes no String NAT gateway name.
    Example: "demo"
    CreatedTime yes no String NAT gateway creation time.
    Example: "2021-05-24 19:28:31"
    State yes no String NAT gateway status. 
    PENDING: Pending, DELETING: Deleting, AVAILABLE: Available, UPDATING: Upgrading,
    FAILED: Failed.
    Example: "AVAILABLE"
    InternetMaxBandwidthOut yes no Uint64 Maximum public outbound bandwidth of gateway (unit: Mbps).
    Example: 10
    MaxConcurrentConnection yes no Uint64 Upper limit of gateway concurrent connections.
    Example: 10000000
    PublicIpAddressSet yes no Array of NatGatewayAddress Array of public IP objects bound to the NAT gateway.
    Example:View
    NetworkState yes no String NAT gateway network status. "AVAILABLE": Available, "UNAVAILABLE": Unavailable, "INSUFFICIENT": Service suspended for overdue payments.
    Example: "AVAILABLE"
    DestinationIpPortTranslationNatRuleSet yes no Array of DestinationIpPortTranslationNatRule Port forwarding rules of the NAT gateway.
    Example:View
    VpcId yes no String VPC instance ID.
    Example: "vpc-demoag78"
    Zone yes no String Availability zone of the NAT gateway.
    Example: "ap-region-2"
    GatewayType no yes String Underlying gateway type. Values are NORMAL and HYPER.
    Example: NORMAL
    TagSet yes no Array of Tag Tag key-value pairs.
    Example:View
    SourceIpTranslationNatRuleSet no no Array of SourceIpTranslationNatRule SNAT rules of the NAT gateway.
    Example:View
    StrictSnatMode no no Bool Whether to only allow forwarding for traffic that matches SNAT rules.
    Example: false
    NatType yes no String NAT workload type.
    Example: "NAT"
    RestrictState yes no String Whether the NAT gateway is blocked.
    Example: "NORMAL"
    SecurityGroupSet yes no Array of String List of security groups bound to the NAT gateway.
    Example: ["sg-12345678"]
    ExclusiveGatewayBandwidth no no Uint64 Bandwidth (unit: Mbps) of the gateway cluster of the dedicated NAT gateway.
    Example: 50000
    DedicatedClusterId yes no String Unique CDC ID.
    Example: cluster-gbo27yc4
    SubnetId yes no String Subnet instance ID.
    Example: subnet-hj3he929
    NatProductVersion yes no Uint64 NAT gateway type. 1: Classic NAT gateway; 2: Standard NAT gateway.
    Example: 1
    InternetMaxBandwidthIn no no Uint64 Maximum public network inbound bandwidth of the gateway (unit: Mbps).
    Example: 10
    DirectConnectGatewayIds yes no Array of String ID of the bound direct connect gateway.
    Example: ["dcg-12345678"]
    SmartScheduleMode yes no Bool Whether to enable the feature of selecting the EIP used for SNAT based on the destination CIDR block.
    Example: false
    IsExclusive yes no Bool Whether the NAT gateway is a dedicated one.
    Example: false
    SharedCount yes no Uint64 Number of sub-instances associated with the shared NAT gateway.
    Example: 0

    AvailabilitySet

    Remaining resource details.

    Referenced by the following interfaces: DescribeAddressAvailability

    name required NULL allowed type description
    AddressCount no yes Int64 Quantity
    Example: 1
    AddressType no yes String IP Type
    Example: EIP
    ApplicableForCLB no yes Bool clb
    Example: False
    ResourceType no yes String Resource Type
    Example: EIP
    Availability no yes String Availability
    Example: Available
    InternetServiceProvider no yes String Line Type
    Example: BGP'
    Zone no yes String Availability Zone
    Example: cqyfm7
    NetworkGroup no yes String Network grouping.
    Example: cq

    FlowLog

    Flow log

    Referenced by the following interfaces: CreateAndAttachNetworkInterface, CreateNetworkInterface, DescribeNetworkInterfaces, DescribeNetworkInterfacesEx, DescribeNetworkInterfacesExtra

    name required NULL allowed type description
    VpcId no no String VPC ID or unified ID. It is recommended to use Unified ID.
    Example: vpc-demoag78
    FlowLogId no no String Unique ID of Flow Log
    Example: fl-demoag78
    FlowLogName no no String Flow Log Instance Name
    Example: demo-flowlog
    ResourceType no no String The resource type of stream log, VPC
    ResourceId no no String Unique Resource ID
    Example: eni-demoag78
    TrafficType no no String Flow log collection type: ACCEPT
    CloudLogId no no String Flow Log Storage ID
    Example:
    CloudLogState no no String Flow Log Storage ID Status
    Example: SUCCESS
    FlowLogDescription no no String Flow Log Description Information
    Example: demo
    CreatedTime no no String Flow log creation time
    Example: 2020-01-30 00:00:00

    NetworkInterfaceExtendIp

    ENI Expanded IP Range

    Referenced by the following interfaces: DescribeNetworkInterfaceExtendIps

    name required NULL allowed type description
    VpcId yes no Uint64 VPC Integer ID
    Example: 6757
    UniqVpcId yes no String Unique ID of VPC
    Example: vpc-67wlqf6v
    EniId yes no Uint64 Integer ID of ENI
    Example: 324
    UniqEniId yes no String Unique ID of ENI
    Example: eni-hhabo1ev
    Ip yes no String Extended IP
    Example: 10.2.3.12

    DfwOssCreateUSGResult

    Complex type: DfwOssCreateUSGResult.

    Referenced by the following interfaces: CreateUSGInternal

    name required NULL allowed type description
    SgId no no String Name of the original DFW API (v2): createUSG.sgId.
    Example: 251197522
    UsgId no no String Name of the original DFW API (v2): createUSG.usgId.
    Example: sg-ispsj3ah
    UsgName no no String Name of the original DFW API (v2): createUSG.usgName.
    Example: test_sdk

    ResourceDashboard

    VPC Resource Dashboard (Number of Each Resource)

    Referenced by the following interfaces: DescribeVpcResourceDashboard

    name required NULL allowed type description
    VpcId yes no String VPC instance ID, e.g., vpc-f1xjkw1b.
    Example: vpc-bq4bzxpj
    SubnetId yes no String Subnet instance ID, e.g., subnet-bthucmmy.
    Example: subnet-bthucmmy
    Classiclink yes no Uint64 Basic network intercommunication.
    Example: 0
    Dcg yes no Uint64 Direct Connect gateway.
    Example: 1
    Pcx yes no Uint64 Peering connection.
    Example: 0
    Ip yes no Uint64 Total number of IPs used.
    Example: 0
    Nat yes no Uint64 NAT gateway.
    Example: 1
    Vpngw yes no Uint64 VPN gateway.
    Example: 0
    FlowLog yes no Uint64 Flow logs.
    Example: 0
    NetworkDetect yes no Uint64 Network probe.
    Example: 0
    NetworkACL yes no Uint64 Network ACL.
    Example: 0
    CVM yes no Uint64 Cloud host.
    Example: 2
    LB yes no Uint64 Cloud Load Balancer.
    Example: 0
    CDB yes no Uint64 Relational database.
    Example: 0
    Cmem yes no Uint64 Memcached.
    Example: 0
    CTSDB yes no Uint64 Time series database.
    Example: 0
    MariaDB yes no Uint64 MariaDB.
    Example: 0
    SQLServer yes no Uint64 SQL Server.
    Example: 0
    Postgres yes no Uint64 TDSQL for PostgreSQL.
    Example: 0
    NAS yes no Uint64 Network attached storage.
    Example: 0
    Greenplumn yes no Uint64 Snova cloud database.
    Example: 0
    Ckafka yes no Uint64 Message queue CKAFKA.
    Example: 0
    Grocery yes no Uint64 Grocery.
    Example: 0
    HSM yes no Uint64 Data encryption service.
    Example: 0
    Tcaplus yes no Uint64 Game storage Tcaplus.
    Example: 0
    Cnas yes no Uint64 Cnas.
    Example: 0
    TiDB yes no Uint64 HTAP database TiDB.
    Example: 0
    Emr yes no Uint64 EMR cluster.
    Example: 0
    SEAL yes no Uint64 SEAL.
    Example: 0
    CFS yes no Uint64 Cloud File Storage (CFS).
    Example: 0
    Oracle yes no Uint64 Oracle.
    Example: 0
    ElasticSearch yes no Uint64 ElasticSearch service.
    Example: 0
    TBaaS yes no Uint64 Blockchain service.
    Example: 0
    Itop yes no Uint64 Itop.
    Example: 0
    DBAudit yes no Uint64 Cloud database auditing.
    Example: 0
    CynosDBPostgres yes no Uint64 Enterprise-level cloud database CynosDB for Postgres.
    Example: 0
    Redis yes no Uint64 Cloud Redis.
    Example: 0
    MongoDB yes no Uint64 Cloud MongoDB.
    Example: 0
    DCDB yes no Uint64 TDSQL for MySQL.
    Example: 0
    CynosDBMySQL yes no Uint64 Enterprise-level cloud database CynosDB for MySQL.
    Example: 0
    Subnet yes no Uint64 Subnet.
    Example: 1
    RouteTable yes no Uint64 Route table.
    Example: 1
    JNS no no Uint64 JNS Service
    Example: 2
    ENI no no Uint64 ENI
    Example: 2
    CDM no no Uint64 CDM
    Example: 2
    CCN no no Uint64 CCN
    Example: 2
    HAVIP no no Uint64 Highly Available Virtual IP
    Example: 2

    DfwOssGetUSGPolicyRequest

    Complex type: DfwOssGetUSGPolicyRequest.

    Referenced by the following interfaces: DescribeUSGPolicyInternal

    name required NULL allowed type description
    UsgId no no String Name of the original DFW API (v2): getUSGPolicy.usgId.
    Example: sg-aassaa

    SecurityGroupLimitSet

    User security group quota limit.

    Referenced by the following interfaces: DescribeSecurityGroupLimits

    name required NULL allowed type description
    SecurityGroupLimit yes no Uint64 Number of security groups that can be created per project per region.
    Example: 100
    SecurityGroupPolicyLimit yes no Uint64 Maximum Number of Rules under a Security Group
    Example: 100
    ReferedSecurityGroupLimit yes no Uint64 Number of Nested Security Group Rules under a Security Group
    Example: 100
    SecurityGroupInstanceLimit yes no Uint64 Number of Instances Associated with Single Security Group
    Example: 100
    InstanceSecurityGroupLimit yes no Uint64 Number of Security Groups Associated with an Instance
    Example: 100
    SecurityGroupReferedCvmAndEniLimit yes no Uint64 Security Group Associated ENI Quota
    Example: 100
    SecurityGroupReferedSvcLimit yes no Uint64 Associated Service Quota of Security Group
    Example: 100
    SecurityGroupExtendedPolicyLimit yes no Uint64 Security Group Extension Policy Quota
    Example: 100

    DfwOssUSGPolicyItem

    Complex type: DfwOssUSGPolicyItem.

    Referenced by the following interfaces: CreateUSGRuleInternal, DescribeUSGPolicyInternal

    name required NULL allowed type description
    ServiceModule no yes String Name of the original DFW API (v2): getUSGPolicy.serviceModule.
    Example: ppm-ni1v9ozg
    AddressModule no yes String Name of the original DFW API (v2): getUSGPolicy.addressModule.
    Example: ipmg-liaueln6
    Id no yes String Name of the original DFW API (v2): getUSGPolicy.id.
    Example: sg-e5qrs5d9
    ModifyTime no yes String Name of the original DFW API (v2): getUSGPolicy.modifytime.
    Example: 2022-06-21 10:46:42
    Desc no yes String Name of the original DFW API (v2): getUSGPolicy.desc.
    Example: test
    Action no no String Name of the original DFW API (v2): getUSGPolicy.action.
    Example: ACCEPT
    Ip no yes String Name of the original DFW API (v2): getUSGPolicy.ip.
    Example: 10.0.0.0/8
    Protocol no yes String Name of the original DFW API (v2): getUSGPolicy.protocol.
    Example: tcp
    Port no yes String Name of the original DFW API (v2): getUSGPolicy.port.
    Example: 80

    DfwOssUSGQuota

    Complex type: DfwOssUSGQuota.

    Referenced by the following interfaces: DescribeUSGQuotaInternal

    name required NULL allowed type description
    UsgCount yes no Uint64 Name of the original VPC OSS API (v2): getUSGById.usgCount.
    Example: 1
    InstanceUsgCount yes no Uint64 Name of the original VPC OSS API (v2): getUSGById.instanceUsgCount.
    Example: 1
    ReferedUsgCount yes no Uint64 Name of the original VPC OSS API (v2): getUSGById. referedUsgCount.
    Example: 1
    CvmVifCount yes no Uint64 Name of the original VPC OSS API (v2): getUSGById.cvmVifCount.
    Example: 1
    ExtendedPolicyCount yes no Uint64 Name of the original VPC OSS API (v2): getUSGById.extendedPolicyCount.
    Example: 1
    PolicyCount yes no Uint64 Name of the original VPC OSS API (v2): getUSGById.policyCount.
    Example: 1
    SvcCount yes no Uint64 Name of the original VPC OSS API (v2): getUSGById.svcCount.
    Example: 1
    UsgInstanceCount yes no Uint64 Name of the original VPC OSS API (v2): getUSGById.usgInstanceCount.
    Example: 1

    VpcOssSubnetForDescribeSubnetInternal

    Complex type: VpcOssSubnetForDescribeSubnetInternal.

    Referenced by the following interfaces: DescribeSubnetInternal

    name required NULL allowed type description
    DhcpFlag no no Int64 Name of the original VPC OSS API (v2): GetSubnet.dhcpFlag.
    Example: 0
    Max no no Int64 Name of the original VPC OSS API (v2): GetSubnet.max.
    Example: 167772415
    GatewayIp no no String Name of the original VPC OSS API (v2): GetSubnet.gwIp.
    Example: 0.0.0.0
    BroadcastFlag no no Int64 Name of the original VPC OSS API (v2): GetSubnet.broadcastFlag.
    Example: 0
    SyncAclToTgwFlag no no Int64 Name of the original VPC OSS API (v2): GetSubnet.syncAclToTgwFlag.
    Example: 0
    UniqueCdcId no no String Name of the original VPC OSS API (v2): GetSubnet.uniqCdcId.
    Example: xx
    Name no no String Name
    Example: test
    LocalZoneFlag no no Int64 Name of the original VPC OSS API (v2): GetSubnet.bLocalZone.
    Example: 0
    UniqueSubnetId no no String The externally unique SubnetId.
    Example: subnet-1ufvulum
    Owner no no String User app ID
    Example: 251197522
    UniqueVpcId no no String The externally unique VPCID.
    Example: vpc-7zayowkt
    ZoneId no no Int64 Name of the original VPC OSS API (v2): GetSubnet.zoneId.
    Example: 100001
    VpcId no no Int64 Integer VPCID.
    Example: 16769060
    SubnetId no no Int64 Integer subnetId.
    Example: 2007467
    Min no no Int64 Name of the original VPC OSS API (v2): GetSubnet.min.
    Example: 167772160
    IntMask no no Int64 Integer mask.
    Example: 24
    Type no no Int64 Name of the original VPC OSS API (v2): GetRoute.type.
    Example: 0
    CreateTime no no String Name of the original VPC OSS API (v2): GetSubnet.createTime.
    Example: 2021-05-10 15:40:12
    RemoteVpcSnatFlag no no Int64 Name of the original VPC OSS API (v2): GetSubnet.bRemoteVpcSnat.
    Example: 0
    Mask no no String Mask
    Example: 255.255.255.0
    DefaultFlag no no Int64 Name of the original VPC OSS API (v2): GetSubnet.bDefault.
    Example: 0
    CdcFlag no no Int64 Name of the original VPC OSS API (v2): GetSubnet.bCdc.
    Example: 0
    Subnet no no String Subnet address
    Example: 10.0.0.0

    ServiceTemplate

    Protocol:port template

    Referenced by the following interfaces: CreateServiceTemplate, CreateServiceTemplateGroup, DescribeServiceTemplateGroups, DescribeServiceTemplates

    name required NULL allowed type description
    ServiceTemplateId yes no String Protocol port instance ID, e.g., ppm-f5n1f8da.
    Example: ppm-f5n1f8da
    ServiceTemplateName yes no String Template name.
    Example: name
    ServiceSet no no Array of String Protocol port information.
    Example: ["tcp:80"]
    CreatedTime no no String Creation time.
    Example: 2021-03-02 14:41:15

    SSLVpnServer

    SSLVpnServer

    Referenced by the following interfaces: DescribeVpnGatewaySSLServers

    name required NULL allowed type description
    VpcId yes no String VPC ID
    Example: vpc-jaif7k23
    VpnSslServerId yes no String VpnSslServerId
    Example: vpns-adwa41c
    VpnGatewayId yes no String VpnGatewayId
    Example: vpngw-1u2xtmbz
    SSLVpnServerName yes no String SSLVpnServerName
    Example: server-name
    LocalAddress yes no String Local Segmentation Address
    Example: 10.0.0.0/16
    RemoteAddress yes no String Customer Address
    Example: 172.0.0.0/23
    MaxConnection yes no Array of Int64 Connections
    Example: 23
    WanIp yes no String Public IP
    Example: jkt.14.51.3
    State yes no Int64 Server Creation Status
    Example: 6
    SSLVpnProtocol no no String The listening protocol of the SSL VPN server.
    Example: UDP
    SSLVpnPort no no String The listening protocol port of the SSL VPN server.
    Example: 1194
    EncryptAlgorithm no no String Encryption algorithm.
    Example: AES-128-CBC
    IntegrityAlgorithm no no String Authentication algorithm.
    Example: SHA1
    CreateTime no no String Creation Time
    Example: 2021-03-24 15:31:56

    DfwOssUSGPolicy

    Complex type: DfwOssUSGPolicy.

    Referenced by the following interfaces: DescribeUSGPolicyInternal

    name required NULL allowed type description
    Version no no Int64 Name of the original DFW API (v2): getUSGPolicy.version.
    Example: 17
    UsgId no no String Name of the original DFW API (v2): getUSGPolicy.usgId.
    Example: sg-5q4brrmt
    ErrorCode no no Int64 Name of the original DFW API (v2): getUSGPolicy.errorCode.
    Example: 0
    Inbound no no Array of DfwOssUSGPolicyItem Name of the original DFW API (v2): getUSGPolicy.inbound.
    Example:View
    Outbound no no Array of DfwOssUSGPolicyItem Name of the original DFW API (v2): getUSGPolicy outbound.
    Example:View

    ExtendCidr

    Extended CIDR.

    Referenced by the following interfaces: CreateVpc, DescribeVpcInternal, DescribeVpcs

    name required NULL allowed type description
    ExtendCidrBlock yes no String Extended CIDR.
    Example: 192.241.0.0/24

    AddressPrice

    Adjust bandwidth inquiry result.

    Referenced by the following interfaces: InquiryPriceCreateIp6Translators, InquiryPriceModifyAddressesBandwidth

    name required NULL allowed type description
    ChargeUnit no no String Billing Unit
    Example: HOUR
    UnitPrice no no Float Unit price
    Example: 21
    DiscountPrice no no Float Discount Price
    Example: 21

    CvmInstance

    CVM instance information.

    Referenced by the following interfaces: DescribeVpcInstances

    name required NULL allowed type description
    VpcId yes no String VPC instance ID.
    Example: vpc-67wlqf6v
    SubnetId yes no String Subnet instance ID.
    Example: subnet-hj3he929
    InstanceId yes no String CVM Instance ID
    Example: ins-nswq8wkq
    InstanceName yes no String CVM name.
    Example: demo
    InstanceState yes no String CVM status.
    Example: RUNNING
    CPU yes no Uint64 The CPU core count of the instance, in cores.
    Example: 8
    Memory yes no Uint64 Instance memory capacity, in GB.
    Example: 32
    CreatedTime yes no String Creation time.
    Example: 2020-06-08 10:00:00
    InstanceType yes no String Instance model.
    Example: SA3.2XLARGE32
    EniLimit yes no Uint64 Instance ENI quota (including the primary network interface).
    Example: 6
    EniIpLimit yes no Uint64 Instance ENI private IP quota (including the primary network interface).
    Example: 20
    InstanceEniCount yes no Uint64 Number of ENIs bound to the instance (including the primary ENI).
    Example: 1

    LocalIpTranslationNatRule

    Local IP Translation Complex Type

    Referenced by the following interfaces: CreateLocalIpTranslationNatRule, CreatePeerIpTranslationNatRule, DeleteLocalIpTranslationNatRule, DeletePeerIpTranslationNatRule, DescribeLocalIpTranslationNatRules, DescribePeerIpTranslationNatRules

    name required NULL allowed type description
    OriginalIp yes no String Original IP
    Example: 10.0.0.5
    TranslationIp yes no String Mapping IP
    Example: 2.2.2.2
    Description yes yes String Description
    Example: for_demo

    SecurityPolicyDatabase

    SecurityPolicyDatabase Policy

    Referenced by the following interfaces: CreateVpnConnection, DescribeVpnConnections, ModifyVpnConnectionAttribute

    name required NULL allowed type description
    LocalCidrBlock yes no String Local IP address range
    Example: 11.0.0.0/8
    RemoteCidrBlock yes no Array of String Peer IP range
    Example: 11.0.0.0/8

    VpcOssDockerRequest

    Complex type: VpcOssDockerRequest.

    Referenced by the following interfaces: CreateDockerInternal

    name required NULL allowed type description
    Subnet no no String Subnet address
    Example: 10.0.0.0
    IntMask no no Int64 Integer mask.
    Example: 16
    UniqueVpcId no no String Unique VPC ID.
    Example: vpc-7zayowkt
    VpcId no no Int64 Integer VPCID.
    Example: 1

    VpcOssNatServiceForCreateNatGatewayServiceInternal

    Complex type: VpcOssNatServiceForCreateNatGatewayServiceInternal.

    Referenced by the following interfaces: CreateNatGatewayServiceInternal

    name required NULL allowed type description
    UniqueVpcId no no String The externally unique VPCID.
    Example: vpc-jmaywf6r
    Vip no no String Name of the original VPC OSS API (v2): AddNatgwService.vip.
    Example: 9.241.203.205
    PrivateIp no no String Name of the original VPC OSS API (v2): AddNatgwService.pip.
    Example: 172.16.0.18
    VirtualPort no no Int64 Name of the original VPC OSS API (v2): AddNatgwService.vport.
    Example: 13803
    Bandwidth no no Int64 Name of the original VPC OSS API (v2): AddNatgwService.bandwidth.
    Example: 0
    SubnetId no no Int64 Integer subnetId.
    Example: 1990866
    Business no no String Name of the original VPC OSS API (v2): AddNatgwService.business.
    Example: xx
    VirtualGatewayType no no Int64 Name of the original VPC OSS API (v2): AddNatgwService.vgwType
    Example: 0
    Protocol no no String Name of the original VPC OSS API (v2): AddNatgwService.proto.
    Example: tcp
    CreateTime no no String Name of the original VPC OSS API (v2): AddNatgwService.createTime.
    Example: 2021-12-27 18:09:40
    UniqueVpcGatewayIndex no no String Name of the original VPC OSS API (v2): AddNatgwService.uniqVgwIndex.
    Example: 172.16.0.18
    GatewayIp no no String Name of the original VPC OSS API (v2): AddNatgwService.gwIp.
    Example: 9.241.203.205
    ProtocolPort no no Int64 Name of the original VPC OSS API (v2): AddNatgwService.pport.
    Example: 554
    PoolId no no Int64 Name of the original VPC OSS API (v2): AddNatgwService.poolId.
    Example: 33362
    VpcId no no Int64 Integer VPCID.
    Example: 78257
    Owner no no String User app ID
    Example: 251198225
    UniqueSubnetId no no String The externally unique SubnetId.
    Example: subnet-am4aebsm
    VpcGatewayIndex no no String Name of the original VPC OSS API (v2): AddNatgwService.vgwIndex.
    Example: 172.16.0.18
    BusinessOwner no no String Name of the original VPC OSS API (v2): AddNatgwService.businessOwner.
    Example: xx

    NetworkAclEntry

    Network ACL rule.

    Referenced by the following interfaces: CreateNetworkAcl, DescribeNetworkAcls, ModifyNetworkAclEntries

    name required NULL allowed type description
    Protocol no no String Protocol, value: TCP, UDP, ICMP, and ALL.
    Example: TCP
    Port no no String Port (all, single, and range). When the protocol is ALL or ICMP, the port cannot be specified.
    Example: 2132
    CidrBlock no no String IP Range or IP (mutually exclusive).
    Example: 192.168.0.0/24
    Ipv6CidrBlock no no String IP Range or IPv6 (mutually exclusive).
    Example: 2001::85b:3c51:f5ff:ffdb
    Action no no String ACCEPT or DROP.
    Example: Accept
    Description no no String Rule description, up to 100 in length.
    Example: demo
    NetworkAclIpv4EntryId no no String Unique ID for the IPv4 network ACL entry. When an ACL entry is modified, either NetworkAclIpv4EntryId or NetworkAclIpv6EntryID should be provided.
    Example:
    Priority no no Int64 Priority, starting from 1.
    Example: 1
    ModifyTime no no String Modify the time.
    Example: 2019-11-11 22:16:17

    VpcOssNatServiceRequest

    Complex type: VpcOssNatServiceRequest.

    Referenced by the following interfaces: DeleteNatGatewayServiceInternal

    name required NULL allowed type description
    UniqueVpcGatewayIndex no no String Name of the original VPC OSS API (v2): DelNatgwService.uniqVgwIndex.
    Example: xxx
    Business no no String Name of the original VPC OSS API (v2): DelNatgwService.business.
    Example: xxx
    SubnetId no no Uint64 Integer subnetId.
    Example: 123
    VpcId no no Int64 Integer VPCID.
    Example: 123
    Owner yes no String User app ID
    Example: 251198225
    Protocol no no String Name of the original VPC OSS API (v2): DelNatgwService.proto
    Example: tcp
    Vip no no String Name of the original VPC OSS API (v2): DelNatgwService.vip.
    Example: 1.1.1.1
    VirtualPort no no Int64 Name of the original VPC OSS API (v2): DelNatgwService.vport.
    Example: 111
    PrivateIp no no String Name of the original VPC OSS API (v2): DelNatgwService.pip.
    Example: 172.16.0.18
    ProtocolPort no no Int64 Name of the original VPC OSS API (v2): DelNatgwService.pport.
    Example: 554
    VpcGatewayIndex no no String Name of the original VPC OSS API (v2): DelNatgwService.vgwIndex.
    Example: xxx
    UniqueVpcId no no String The externally unique VPCID.
    Example: vpc-jmaywf6r
    VirtualGatewayType no no Int64 Name of the original VPC OSS API (v2): DelNatgwService.vgwType.
    Example: 0

    AddressBasic

    EIP Basic Information

    Referenced by the following interfaces: DescribeAddressesHistory

    name required NULL allowed type description
    AddressIp no no String Public Network IP Address
    Example: 10.23.32.2
    AddressId yes no String ID of EIP, which is the unique identifier of EIP.
    Example: eip-d97psd1o
    AddressType yes no String EIP resource types, including "CalcIP", "WanIP", "EIP", and "AnycastEIP". Where, "CalcIP" indicates device IP; "WanIP" indicates general public network IP; "EIP" indicates elastic public IP; and "AnycastEip" indicates accelerated EIP.
    Example: EIP
    InternetServiceProvider yes no String EIP ISP information, including CMCC, CTCC, CUCC, and BGP, where CMCC indicates Mobile, CTCC indicates Telecom, CUCC indicates Unicom, and BGP indicates BGP interfacing ISP.
    Example: BGP
    Status yes no String EIP usage status. "used" indicates that the IP address is occupied in the current region; "unused" indicates that the IP address is not occupied in the current region.
    Example: Used
    AnycastZone yes no String An Anycast publishing domain is a region for accelerating IP address publishing. It is the POP access point for publishing VIP addresses of Anycast CLB instances. The client accesses the nearest POP access point. Currently, Anycast CLB instances support the following publishing domains:
    Publishing domain A (ANYCAST_ZONE_A): Mainly contains regions in Europe and America. VIP addresses will be published simultaneously in Toronto, Silicon Valley, Frankfurt, Virginia, and Moscow.
    Publishing domain B (ANYCAST_ZONE_B): Mainly contains regions in Southeast Asia. VIP addresses will be published simultaneously in Singapore, Seoul, Mumbai, Bangkok, and Tokyo.
    Example: ap-region-1
    Address no no String Public IP address.
    Example: eip-37xao8t

    AccountAttribute

    Account Attribute Object

    Referenced by the following interfaces: DescribeAccountAttributes

    name required NULL allowed type description
    AttributeName yes no String Attribute Name
    Example: supported-platforms
    AttributeValues yes no Array of String Attribute Value
    Example: ["VPC"]

    CustomerGateway

    Customer gateway

    Referenced by the following interfaces: CreateCustomerGateway, DescribeCustomerGateways

    name required NULL allowed type description
    CustomerGatewayId yes no String Unique ID of User Gateway
    Example: cgw-ea2fck23
    CustomerGatewayName yes no String Gateway name
    Example: demo-name
    IpAddress yes no String Public network address
    Example: 1.3.15.5
    CreatedTime yes no String Creation Time
    Example: 2021-02-03 00:00:00
    VpnConnNum no no Uint64 The number of associated channels.
    Example: 1
    BgpAsn no no Int64 BGP ASN.
    Example: 6000

    NewRouteSet

    New Route Name

    Referenced by the following interfaces: ReplaceRoutes

    name required NULL allowed type description
    RouteId no no String Route ID
    Example: 16820
    DestinationCidrBlock no no String Target IP Range
    Example: 169.254.128.0/17
    GatewayType no no String Gateway type
    Example: NORMAL_CVM
    GatewayId no no String Gateway ID
    Example: 172.16.16.37
    RouteDescription no no String Route Description
    Example: demo

    UpdateVpcAssistCidrResult

    Result of updating the secondary CIDR blocks of VPC.

    Referenced by the following interfaces: UpdateVpcAssistCidrInternal

    name required NULL allowed type description
    NewAfcFlag yes no Int64 Original parameter: bNewAfc.
    Example: 1
    CreateTime yes no String Original parameter: createTime.
    Example: 2021-05-17 19:55:20
    OwnedFlag yes no Int64 Original parameter: ownrdFlag.
    Example: 0
    OldOperationRouteToVbcFlag yes no Int64 Original parameter: oldBOpRouteToVbc.
    Example: 0
    VpcId yes no Int64 Original parameter: vpcId.
    Example: 16769060
    UniqueVpcId yes no String Original parameter: uniqVpcId.
    Example: vpc-7zayowkt
    VpgId yes no Int64 Original parameter: vpgId.
    Example: 53786
    Owner yes no String Original parameter: owner.
    Example: 251197522
    IntMask yes no Int64 Original parameter: intMask.
    Example: 16
    OperationRouteToVbcFlag yes no Int64 Original parameter: bOpRouteToVbc.
    Example: 1
    VpcSubnet yes no String Original parameter: vpcSubnet.
    Example: 10.0.0.0
    ZoneVpgFlag yes no Int64 Original parameter: bZoneVpg.
    Example: 0
    OldPublishVpgFlag yes no Int64 Original parameter: oldBPublishVpg.
    Example: 1
    VpcAssistCidrId yes no Int64 Original parameter: vpcAssistCidrId.
    Example: 22811
    AssistType yes no Int64 Original parameter: assistType.
    Example: 0
    Subnet yes no String Original parameter: subnet.
    Example: 10.4.0.0
    Mask yes no String Original parameter: mask.
    Example: 255.255.0.0
    VpcIntMask yes no Int64 Original parameter: vpcIntMask.
    Example: 16

    DefaultVpcSubnet

    Default VPC and Subnet

    Referenced by the following interfaces: CreateDefaultVpc

    name required NULL allowed type description
    VpcId yes no String Default VpcId
    Example: vpc-6vbg797r
    SubnetId yes no String Default Subnet Id
    Example: subnet-3opmksyg
    VpcName no no String Default VPC name.
    Example: Default-VPC
    CidrBlock no no String Default subnet CIDR.
    Example: 172.16.0.0/16
    DhcpOptionsId no no String ID of DHCP option set.
    Example: dopt-7t8toql2
    DnsServerSet no no String DNS list.
    Example: ['183.60.82.98']
    DomainName no no String DHCP domain option.
    Example: demo

    DBInstances

    Database instance details.

    Referenced by the following interfaces: DescribeDBInstancesWithSecurityGroup

    name required NULL allowed type description
    InstanceId yes no String Instance ID format, e.g., crs-1newjcxb.
    Example: crs-1newjcxb
    InstanceIp yes no String Instance IP, e.g., 172.16.32.18.
    Example: 172.16.32.18
    InstanceName yes no String Instance name.
    Example: cfs-qci
    VpcId yes no String Unique VPC ID, e.g., vpc-q9iejf9r.
    Example: vpc-67wlqf6v

    AddressChargePrepaid

    Cost Object for Describing EIP

    Referenced by the following interfaces: AllocateAddresses, InquiryPriceAllocateAddresses

    name required NULL allowed type description
    Period yes no Int64 Instance Purchase Duration
    Example: 0
    RenewFlag no no String Auto-renewal Flag
    Example: AutoRenewFlag

    ServiceTemplateGroup

    Protocol Port Template Collection

    Referenced by the following interfaces: CreateServiceTemplateGroup, DescribeServiceTemplateGroups

    name required NULL allowed type description
    ServiceTemplateGroupId yes no String Instance ID of protocol port template collection, e.g., ppmg-2klmrefu.
    Example: ppmg-p4oaqawq
    ServiceTemplateGroupName yes no String Protocol port template collection name.
    Example: demo
    ServiceTemplateIdSet yes no Array of String Protocol port template instance ID.
    Example: ["ppm-529nwwj8", "ppm-4dw6agho"]
    CreatedTime no no String Creation time.
    Example: 2018-06-21 11:32:29
    ServiceTemplateSet yes no Array of ServiceTemplate Protocol port template instance information.
    Example:View

    CustomerGatewayVendor

    Customer gateway vendor information object.

    Referenced by the following interfaces: DescribeCustomerGatewayVendors, DownloadCustomerGatewayConfiguration

    name required NULL allowed type description
    Platform yes no String Platform.
    Example: comware
    SoftwareVersion yes no String Software version.
    Example: V1.0
    VendorName yes no String Vendor name.
    Example: h3c

    InternetPrice

    Public Network Inquiry Output Parameters

    Referenced by the following interfaces: InquiryPriceAllocateAddresses

    name required NULL allowed type description
    AddressPrice no no InternetPriceDetail Detailed parameters of Public IP inquiry.
    Example:View

    NetworkInterfaceAttachment

    ENI Binding Relationship

    Referenced by the following interfaces: CreateAndAttachNetworkInterface, CreateNetworkInterface, DescribeNetworkInterfaces, DescribeNetworkInterfacesEx, DescribeNetworkInterfacesExtra

    name required NULL allowed type description
    InstanceId yes no String Cloud host instance ID.
    Example: ins-89k2kjt4
    DeviceIndex yes no Uint64 Sequence number of the ENI inside the CVM instance.
    Example: 0
    InstanceAccountId yes no String Account information of CVM owner.
    Example: jkt4567
    AttachTime yes no String Binding time.
    Example: 2021-06-17 11:24:24

    SecurityGroup

    Security Group Object

    Referenced by the following interfaces: CloneSecurityGroup, CreateDefaultSecurityGroup, CreateSecurityGroup, CreateSecurityGroupWithPolicies, DescribeSecurityGroups

    name required NULL allowed type description
    ProjectId no no String Project ID. Default value: 0. It can be queried on the project management page in the console.
    Example: 0
    SecurityGroupId yes no String Security group instance ID, e.g., sg-ohuuioma.
    Example: sg-05bb4upy
    SecurityGroupName yes no String Security Group Name: can be freely named but the name must not exceed 60 characters.
    Example: demoGroup
    SecurityGroupDesc yes no String Security group remarks, up to 100 characters.
    Example: demo-group-desc
    IsDefault no no Bool Whether it is the default security group. The default security group cannot be deleted.
    Example: false
    CreatedTime no no String Security group creation time.
    Example: 2017-04-18 21:02:30
    TagSet no no Array of Tag Tag key-value pairs.
    Example:View
    UpdateTime no no String Security group update time.
    Example: 2017-04-18 21:02:30
    Region no no String Region.
    Example: sz

    GatewayFlowMonitorDetail

    Gateway Traffic Monitoring Details

    Referenced by the following interfaces: DescribeGatewayFlowMonitorDetail

    name required NULL allowed type description
    PrivateIpAddress yes no String Source IP.
    Example: 10.0.1.21
    InPkg yes no Uint64 Input packet volume.
    Example: 100
    OutPkg yes no Uint64 Packet output quantity.
    Example: 100
    InTraffic yes no Uint64 Inbound bandwidth, in Byte.
    Example: 100
    OutTraffic yes no Uint64 Outbound bandwidth, in Bytes.
    Example: 100

    ClassicLinkInstance

    VPC and Basic Network Interconnection Device

    Referenced by the following interfaces: DescribeClassicLinkInstances

    name required NULL allowed type description
    VpcId yes no String VPC Instance ID
    Example: vpc-67wlqf6v
    InstanceId yes no String Unique ID of CVM instance
    Example: ins-kngiybxl

    VpcOssRoutingTable

    Complex type: VpcOssRoutingTable.

    Referenced by the following interfaces: DescribeRoutingTableListDetailInternal

    name required NULL allowed type description
    VpcDefaultFlag no no Int64 Name of the original VPC OSS API (v2): GetRtbListDetail.vpcBDefault.
    Example: 1
    Subnet no no Array of VpcOssSubnet Subnet address
    Example:View
    Name no no String Name
    Example: default
    UniqueVpcId no no String The externally unique VPCID.
    Example: vpc-jmaywf6r
    RoutingTableId no no Int64 Name of the original VPC OSS API (v2): GetRtbListDetail.rtbId.
    Example: 213266
    RouterId no no Int64 Name of the original VPC OSS API (v2): GetRtbListDetail.routerId.
    Example: 196826
    SubnetNum no no Int64 Name of the original VPC OSS API (v2): GetRtbListDetail.subnetNum.
    Example: 1
    UniqueRouterId no no String Name of the original VPC OSS API (v2): GetRtbListDetail.uniqRouterId.
    Example: router-omlmjmr6
    Owner no no String User app ID
    Example: 251198225
    UniqueRoutingTableId no no String Name of the original VPC OSS API (v2): GetRtbListDetail.uniqRtbId.
    Example: rtb-c6mxqnvy
    Type no no Int64 Name of the original VPC OSS API (v2): GetRtbListDetail.type.
    Example: 1
    CreateTime no no String Name of the original VPC OSS API (v2): GetRtbListDetail.createTime.
    Example: 2021-03-22 20:59:55
    VpcId no no Int64 Integer VPCID.
    Example: 78257
    VpcIntMask no no Int64 Name of the original VPC OSS API (v2): GetRtbListDetail.vpcIntMask.
    Example: 16
    VpcMask no no String Name of the original VPC OSS API (v2): GetRtbListDetail.vpcMask.
    Example: 255.255.0.0
    VpcSubnet no no String Name of the original VPC OSS API (v2): GetRtbListDetail.vpcSubnet.
    Example: 172.16.0.0
    VpcName no no String Name of the original VPC OSS API (v2): GetRtbListDetail.vpcName.
    Example: Default-VPC

    Ipv6VpcSet

    IPv6 address pool information.

    Referenced by the following interfaces: DescribeIpv6Vpc

    name required NULL allowed type description
    SectionId no no Uint64 ID of the associated IPv6 address pool.
    Example: 1
    CidrBlock no no String IPv6 address range.
    Example: 3402:4e00:20:1200::/56
    AddressType no no Uint64 IPv6 address type.
    Example: 0/1
    EnableSplit no no Uint64 Whether to support automatic splitting.
    Example: 0: not supported; 1: customization supported.
    Flag no no Uint64 Whether it is idle.
    Example:
    Description no no String Description information.
    Example:

    SellingModelTag

    Available VPN Model Tags and Corresponding CPU Architecture List

    Referenced by the following interfaces: DescribeVpnSellingModelTaglist

    name required NULL allowed type description
    CpuType no no String CPU Architecture
    Example: X86
    VsModelTag no no String VS Model Tag
    Example: vs_vpn_intel

    ConflictSource

    Conflicting resource information.

    Referenced by the following interfaces: CheckAssistantCidr

    name required NULL allowed type description
    ConflictSourceId yes no String Conflicting Resource ID
    Example: rtb-4t7fr3fi
    SourceItem yes no String Conflicting Resources
    Example: 10.0.0.0/16
    ConflictItemSet yes no Array of ConflictItem Conflicting Resource Entry Information
    Example:View

    AddressTemplateGroup

    IP Address Template Collection

    Referenced by the following interfaces: CreateAddressTemplateGroup, DescribeAddressTemplateGroups

    name required NULL allowed type description
    AddressTemplateGroupName yes no String Name of IP address template collection.
    Example: demo
    AddressTemplateGroupId yes no String IP address template collection instance ID, e.g., ipmg-dih8xdbq.
    Example: ipmg-oono4p1w
    AddressTemplateIdSet yes no Array of String IP address template ID.
    Example:  ['ipm-88t6207k','ipm-mdunqeb6']
    CreatedTime no no String Creation time.
    Example: 2018-06-21 11:32:29
    AddressTemplateSet yes no Array of AddressTemplateItem IP address template instance.
    Example:View

    ServiceRoute

    Service routing information.

    Referenced by the following interfaces: DescribeServiceInternal

    name required NULL allowed type description
    Weight no no Uint64 Weight
    Example: 12
    ProtocolPort no no Uint64 Protocol port number.
    Example: 21
    ZoneId no no Uint64 Availability Zone ID
    Example: 10002
    HostIp no no String Host IP
    Example: 193.0.0.1
    PrivateIP no no String Private IP
    Example: 10.0.0.1
    ForwardingMode no no Uint64 Forwarding mode.
    Example: 0

    VpcLimit

    VPC Quota

    Referenced by the following interfaces: DescribeVpcLimits

    name required NULL allowed type description
    LimitType yes no String VPC Quota Description
    Example: appid-max-vpcs
    LimitValue yes no Uint64 VPC Quota Value
    Example: 0

    RouteTableAssociation

    Route Table Association

    Referenced by the following interfaces: CreateIpv6Routes, CreateRouteTable, CreateRoutes, DescribeRouteTables

    name required NULL allowed type description
    SubnetId yes no String Subnet instance ID.
    Example: subnet-8qywqc4y
    RouteTableId yes no String Route table instance ID.
    Example: rtb-q8o2z892

    HaVipSet

    HaVip Binding CVM ENI Information

    Referenced by the following interfaces: FlushHaVip

    name required NULL allowed type description
    VpcId yes no String VPC instance ID.
    Example: vpc-67wlqf6v
    Vip yes no String Virtual IP address.
    Example: 10.2.3.12
    IfnName no no String ENI interface name.
    Example: veth_21CF51f0
    MacAddress no no String ENI MAC address.
    Example: 20:90:6F:69:CA:7F

    PeerConnection

    Peering connection instance information.

    Referenced by the following interfaces: DescribeVpcPeeringConnections

    name required NULL allowed type description
    VpcId yes no String Unique ID of the local VPC.
    Example: vpc-67wlqf6v
    VpcName yes no String Local VPC name.
    Example: demo
    VpcCidrBlock yes no String IPv4 CIDR of local VPC.
    Example: 10.0.0.0/8
    PeerVpcId yes no String Unique ID of the customer VPC.
    Example: vpc-demo5678
    PeerVpcName yes no String Customer VPC name.
    Example: demo
    PeerVpcCidrBlock yes no String IPv4 CIDR of the customer VPC.
    Example: 172.0.0.0/8
    PeeringConnectionId yes no String Unique ID of peering connection.
    Example: pcx-demojkt4
    PeeringConnectionName yes no String Peering connection name.
    Example: Example
    State yes no String Peering connection status. PENDING: Pending, ACTIVE: Active, REJECTED: Rejected, DELETED: Deleted, and FAILED: Failed.
    Example: PEDNING
    Type yes no Int64 0: Basic network interconnection; 1: Inter-VPC interconnection; 2: Interconnection between VPC and BM;
    Example: VPC_PEER
    IsNgw yes no Int64 0: NewAfc; 1: Not.
    Example: true
    Bandwidth yes no Int64 Bandwidth value of peering connection.
    Example: 10
    SrcRegion yes no String Local region.
    Example: 500001
    DstRegion yes no String Customer region.
    Example: 500002
    CreateTime yes no String Creation time.
    Example: 2019-01-15 11:07:15
    AppId yes no Int64 Local APPID.
    Example: jkt456789
    PeerAppId yes no Int64 Customer APPID.
    Example: jkt456789
    Uin yes no Uint64 UIN.
    Example: 100000072292
    TagSet no yes Array of Tag Tag Information
    Example:View
    PeerUin no no Uint64 Customer UIN
    Example: 100000072292
    ChargeType no no String Recent Change Type
    Example: POSTPAID_BY_DAY_MAX

    SecurityGroupPolicyCheckInfo

    Security Group Policy Detection Result Object

    Referenced by the following interfaces: CheckSecurityGroupPolicies

    name required NULL allowed type description
    Direction yes no String Data flow direction. Values are inbound and outbound.
    Example: EGRESS
    Protocol yes no String Protocol, value: TCP, UDP, and ICMP.
    Example: TCP
    Port yes no String Port number. It is the destination port for inbound, and the source port for outbound.
    Example: 122
    Action yes no String Whether the data flow is accepted. Valid values: ACCEPT (accepted), DROP (rejected).
    Example: DROP

    DfwOssVMOperateResult

    Complex type: DfwOssVMOperateResult.

    Referenced by the following interfaces: AttachPolicyToVMInternal, DeletePolicyFromVmInternal

    name required NULL allowed type description
    Uuid no no String Name of the original DFW API (v2): addPolicyToVM.uuid.
    Example: 84f9a2ad-6659-4864-808c-bd17f3c2acea
    ErrorCode no no Int64 Name of the original DFW API (v2): addPolicyToVM.errorCode.
    Example: 0
    ErrorInfo no no String Name of the original DFW API (v2): addPolicyToVM.errorInfo.
    Example: success

    VpcIpv6Address

    VPC private IPv6 object.

    Referenced by the following interfaces: DescribeVpcIpv6Addresses

    name required NULL allowed type description
    Ipv6Address yes no String IPv6 address within VPC.
    Example: CVM/ENI
    CidrBlock yes no String Subnet IPv6 CIDR.
    Example: 192.241.0.0/24
    Ipv6AddressType yes no String IPv6 type.
    Example: CVM/ENI
    CreatedTime yes no String IPv6 application time.
    Example: 2019-03-11T17:58:07

    LocalIpTranslationAclRuleNeedId

    Local IP Translation ACL Rule Complex Type

    Referenced by the following interfaces: ModifyLocalIpTranslationAclRule

    name required NULL allowed type description
    Protocol yes no String Protocol
    Example: tcp
    SourcePort yes no String Source Port
    Example: 80
    DestinationCidr yes no String Destination IP
    Example: 2.2.2.0/16
    DestinationPort yes no String Destination port
    Example: 80
    Action no no Int64 0 or 1
    Example: 0
    AclRuleId yes no Int64 Rule ID
    Example: 100

    SSLVpnClient

    SSLVpnClient

    Referenced by the following interfaces: DescribeVpnGatewaySSLClients

    name required NULL allowed type description
    VpcId yes no String VPCID
    Example: vpc-jaif7k23
    VpnSslServerId yes no String VpnSslServerId
    Example: vpns-cjkt5c
    CertStatus yes no Int64 Certificate Status
    Example: 6
    VpnSslClientId yes no String VpnSslClientId
    Example: vpnc-awe1254
    CertBeginTime yes no Datetime Certificate Creation Time
    Example: 2021-02-03 00:00:00
    CertEndTime yes no Datetime Certificate expiration time
    Example: 2021-02-04 00:00:00
    State yes no Int64 Client Creation Status
    Example: 6
    Name no no String SSL VPN client name
    Example: vpn-client

    BandwidthAttribute

    Bandwidth Attributes

    Referenced by the following interfaces: DescribeBandwidthAttribute

    name required NULL allowed type description
    NetworkPayMode yes yes Array of String Network billing mode list. Values include
    BANDWIDTH_POSTPAID_BY_MONTH,
    BANDWIDTH_PREPAID_BY_MONTH,
    TRAFFIC_POSTPAID_BY_HOUR,
    BANDWIDTH_POSTPAID_BY_HOUR,
    BANDWIDTH_PACKAGE.
    Example: TRAFFIC_POSTPAID_BY_HOUR
    networkPayMode no yes Array of Int64 Network billing mode list.
    Example: TRAFFIC_POSTPAID_BY_HOUR
    CvmPayMode yes yes Array of String CVM instance billing mode list. Values include "PREPAID", "POSTPAID_BY_HOUR", and "CDHPAID".
    Example: POSTPAID_BY_HOUR
    cvmPayMode no yes Array of Int64 List of CVM instance billing modes.
    Example: POSTPAID_BY_HOUR
    Cpu yes yes Array of Int64 CPU core range, a front-off rear-off range, e.g., [9,23], which indicates 9 <= CPU core count <= 23. An empty range indicates support for any CPU core count.
    Example: 1
    cpu no yes Array of Int64 CPU core range, a front-off rear-off range, e.g., [9,23], which indicates 9 <= CPU core count <= 23. An empty range indicates support for any CPU core count.
    Example: 1
    ZoneId yes yes Array of Int64 Availability zone ID list. An empty list indicates support for any availability zone ID.
    Example: 21
    zoneId no yes Array of Int64 Availability zone ID list. An empty list indicates support for any availability zone ID.
    Example: 21
    BandwidthUpper yes no Int64 Maximum Bandwidth
    Example: 200
    bandwidthUpper no yes Int64 Maximum Bandwidth
    Example: 200
    BandwidthLimit yes yes Int64 Whether the bandwidth must have a cap. 1 indicates Yes, and 0 indicates No.
    Example: 0
    bandwidthLimit no yes Int64 Whether the bandwidth must have a cap. 1 indicates Yes, and 0 indicates No.
    Example: 0
    ResourceIds no no String List of unique IDs of resources, which can be CVM Instance ID, or unique ID of EIP.
    Example: eip-d97psd1o

    DfwOssAddPolicyToVMRequest

    Complex type: DfwOssAddPolicyToVMRequest.

    Referenced by the following interfaces: AttachPolicyToVMInternal

    name required NULL allowed type description
    IsTop no no Bool Name of the original DFW API (v2): addPolicyToVM.isTop.
    Example: True
    Policies no no Array of DfwOssPolicies Name of the original DFW API (v2): addPolicyToVM.policies.
    Example:View
    Uuid no no String Name of the original DFW API (v2): addPolicyToVM.uuid.
    Example: 84f9a2ad-6659-4864-808c-bd17f3c2acea

    Ip6Translator

    IPv6 Translation Instance Information

    Referenced by the following interfaces: DescribeIp6Translators

    name required NULL allowed type description
    Ip6TranslatorId yes no String The unique ID of the IPv6 translation instance, such as ip6-37xao8t.
    Example: ip6-mhnrv51i
    Ip6TranslatorName yes no String Name of IPv6 Translation Instance
    Example: demo
    Vip6 yes no String IPv6 Address
    Example: 2402:4e00:40:40::2:2a6
    IspName yes no String ISP of the IPv6 Translation Address
    Example: BGP
    TranslatorStatus yes no String Translation instance status, limited to CREATING, RUNNING, DELETING, and MODIFYING.
    Example: RUNNING
    CreatedTime yes no Datetime_iso IPv6 Translation Instance Creation Time
    Example: 2020-01-30 00:00:00
    Ip6RuleCount yes no Int64 Number of IPV6 Conversion Rules Bound
    Example: 2
    Ip6RuleSet yes no Array of Ip6Rule IPv6 Conversion Rule Information
    Example:View
    CreatedTimeLocal no no Datetime Local Time for Creation of IPv6 Translation Instances
    Example: 2023-07-13T11:12:06

    LocalSourceIpPortTranslationNatRule

    Direct Connect Gateway Local Source IP Port NAT Mapping Address Pool

    Referenced by the following interfaces: CreateLocalSourceIpPortTranslationNatRule, DeleteLocalSourceIpPortTranslationNatRule, DescribeLocalSourceIpPortTranslationNatRules, ModifyLocalSourceIpPortTranslationNatRule

    name required NULL allowed type description
    IpPool yes no String IP Address Pool
    Example: 2.2.2.2/16
    Description yes no String Description
    Example: for_demo

    AclRuleIdType

    Local IP Translation ACL Rule ID Complex Type

    Referenced by the following interfaces: DeleteLocalSourceIpPortTranslationAclRule

    name required NULL allowed type description
    AclRuleId yes no Int64 Rule ID
    Example: 5

    SingleIspZone

    Mapping Relationships between Availability Zone and the Three ISPs

    Referenced by the following interfaces: DescribeSingleIspRegion

    name required NULL allowed type description
    Zone yes no String Availability Zone
    Example: region
    ZoneId yes no Uint64 Availability Zone ID
    Example: 50001
    Singleisp yes no Array of String 3 ISPs, including CMCC, CTCC, and CUCC.
    Example: CTCC

    Ipv6SubnetCidrBlock

    IPv6 subnet IP range object.

    Referenced by the following interfaces: AssignIpv6SubnetCidrBlock, UnassignIpv6SubnetCidrBlock

    name required NULL allowed type description
    SubnetId yes no String Subnet instance ID, e.g., subnet-pxir56ns.
    Example: subnet-8qywqc4y
    Ipv6CidrBlock no no String IPv6 subnet IP range, e.g., 3402:4e00:20:1001::/64.
    Example: 3402:4e00:20:1200::/56
    AddressType no no String IPv6 address type.
    Example: GUA
    ISPType no no String ISP type of the IPv6 CIDR block. Valid values: 'BGP' (default type), 'CMCC', 'CTCC', and 'CUCC'.
    Example: BGP

    Ip6RuleInfo

    IPv6 Translation Rules

    Referenced by the following interfaces: AddIp6Rules

    name required NULL allowed type description
    Vport6 yes no Int64 IPv6 port number, ranging from 0 to 65,535.
    Example: 80
    Protocol yes no String Protocol type, supporting TCP/UDP.
    Example: TCP
    Vip yes no String IPv4 Address
    Example: 172.0.0.0
    Vport yes no Int64 IPv4 port number, ranging from 0 to 65,535.
    Example: 80

    VpnConnection

    VPN channel object.

    Referenced by the following interfaces: CreateVpnConnection, DescribeVpnConnections

    name required NULL allowed type description
    VpnConnectionId yes no String Channel instance ID.
    Example: vpnx-7m3llk0z
    VpnConnectionName yes no String Tunnel name.
    Example: tunnel_name
    VpcId yes no String VPC instance ID.
    Example: vpc-cd20bl9ox
    VpnGatewayId yes no String VPN gateway instance ID.
    Example: vpngw-mjuqp21j
    CustomerGatewayId yes no String Customer gateway instance ID.
    Example: cgw-gj1n0rz6
    PreShareKey yes no String Pre-shared key.
    Example: presharekey
    VpnProto yes no String Channel transmission protocol.
    Example: IPSEC
    EncryptProto yes no String Tunnel encryption protocol.
    Example: IKE
    RouteType yes no String Route type.
    Example: StaticRoute
    CreatedTime yes no Datetime Creation time.
    Example: 0000-00-00 00:00:00
    State yes no String Tunnel status. PENDING: pending, AVAILABLE: available, DELETING: deleting.
    Example: AVAILABLE
    NetStatus yes no String Channel connection status. AVAILABLE: Connected.
    Example: AVAILABLE
    SecurityPolicyDatabaseSet yes no Array of SecurityPolicyDatabase SPD.
    Example:View
    IKEOptionsSpecification yes no IKEOptionsSpecification IKE options.
    Example:View
    IPSECOptionsSpecification yes no IPSECOptionsSpecification IPSEC selection.
    Example:View
    NegotiationType no no String Negotiation type, which is default to active (active negotiation).
    Example: active
    DpdEnable no no Int64 DPD detection switch. The default value is 0, which indicates that DPD detection is disabled. Valid values: 0 (disabled); 1 (enabled).
    Example: 0
    DpdTimeout no no String DPD timeout duration, which is the time required to confirm the absence of the peer. This is effective when dpdEnable is set to 1 (enabled). The default value is 30 seconds.
    Example: 30
    DpdAction no no String The action to take after DPD timeout. The default is clear.
    Example: clear

    DestinationIpPortTranslationNatRule

    Port Forwarding Rules of NAT Gateway

    Referenced by the following interfaces: CreateNatGateway, CreateNatGatewayDestinationIpPortTranslationNatRule, DeleteNatGatewayDestinationIpPortTranslationNatRule, DescribeNatGateways, ModifyNatGatewayDestinationIpPortTranslationNatRule

    name required NULL allowed type description
    IpProtocol yes no String IP, options: TCP and UDP.
    Example: TCP
    PublicIpAddress yes no String Elastic IP.
    Example: 20.20.20.20
    PublicPort yes no Uint64 Public network port.
    Example: 80
    PrivateIpAddress yes no String Private network address.
    Example: 10.10.10.10
    PrivatePort yes no Uint64 VPC port.
    Example: 80
    Description yes no String Description of NAT gateway forwarding rules.
    Example: for_demo

    SecurityGroupPolicyTemplate

    Security Group Rule Template

    Referenced by the following interfaces: DescribeSecurityGroupPolicyTemplates

    name required NULL allowed type description
    TemplateName yes no String Template name.
    Example: demo
    TemplateRemark yes no String Template description.
    Example: demo
    Ingress yes no Array of SecurityGroupPolicy Inbound rules.
    Example:View
    Egress yes no Array of SecurityGroupPolicy Outbound rules.
    Example:View

    VpngwCcnRoutes

    VPN Gateway CCN Route Information

    Referenced by the following interfaces: DescribeVpnGatewayCcnRoutes, ModifyVpnGatewayCcnRoutes

    name required NULL allowed type description
    RouteId yes no String Route Information ID
    Example: vpnr-gj1n0rz6
    Status no no String Whether route information is enabled.
    ENABLE: Enable this route
    DISABLE: Disable this route.
    Example: ENABLE

    Vpc

    VPC object.

    Referenced by the following interfaces: CreateVpc, DescribeVpcInternal, DescribeVpcs

    name required NULL allowed type description
    VpcName yes no String VPC name.
    Example: demo
    VpcId yes no String VPC instance ID, e.g., vpc-azd4dt1c.
    Example:  vpc-azd4dt1c
    CidrBlock yes no String IPv4 CIDR of VPC.
    Example: 10.0.0.0/16
    IsDefault no no Bool Whether it is VPC by default.
    Example:  true
    EnableMulticast yes no Bool Whether to enable multicast.
    Example: true 
    CreatedTime no no String Creation time.
    Example:  2021-01-03 22:25:45
    DnsServerSet yes no Array of String DNS list.
    Example:  -
    DomainName yes no String DHCP domain option.
    Example:  demo
    DhcpOptionsId yes no String ID of DHCP option set.
    Example:  -
    EnableDhcp yes no Bool Whether DHCP is enabled.
    Example:  false
    Ipv6CidrBlock no no String IPv6 CIDR of VPC.
    Example:  -
    TagSet yes no Array of Tag Tag Key-value Pairs
    Example:View
    AssistantCidrSet no yes Array of AssistantCidr Auxiliary CIDR
    Example:View
    BmsNum no yes Int64 BMS quantity.
    Example: 2
    ExtendCidrSet no yes Array of ExtendCidr Extended CIDR list.
    Example:View
    IsShare no no Bool Whether it is a shared resource.
    Example: True
    EnableCdcPublish no no Bool Switch for publishing the CDC subnet to CCN. true: publish; false: not publish.
    Example: False
    EnableRouteVpcPublish no no Bool Route publishing policy when VPC is associated with CCN. true: enable CIDR route publishing; false: enable subnet route publishing. By default, subnet route publishing is enabled when a VPC is created.
    Example: True
    CdcId no no String Unique ID of CDC.
    Example: cdc-2loean7x
    VpcFlag no no Uint64 Whether it is a self-developed VPC: 0: no; 1: yes.
    Example:
    Region no no String Region.
    Example: sz

    VpcOssGlobalRoute

    Complex type: VpcOssGlobalRoute.

    Referenced by the following interfaces: DescribeGlobalRouteInternal

    name required NULL allowed type description
    Subnet no no String Subnet address
    Example: 100.64.0.0
    IntMask no no Int64 Integer mask.
    Example: 24
    Remote no no String Name of the original VPC OSS API (v2): GetGlobalRoute.remote.
    Example: 172.16.0.2
    Master no no String Name of the original VPC OSS API (v2): GetGlobalRoute.master.
    Example: 16.5.3.6
    VpcId no no Int64 Integer VPCID.
    Example: 22

    VpcOssGlobalRouteRequest

    Complex type: VpcOssGlobalRouteRequest.

    Referenced by the following interfaces: CreateGlobalRouteInternal, DeleteGlobalRouteInternal

    name required NULL allowed type description
    VpcId no no Int64 Integer VPCID.
    Example: 1
    Subnet no no String Subnet address
    Example: 10.0.0.0
    IntMask no no Int64 Integer mask.
    Example: 16
    Remote no no String Name of the original VPC OSS API (v2): DelGlobalRoute.remote.
    Example: 172.16.0.18
    Type no no Int64 Name of the original VPC OSS API (v2): DelGlobalRoute.type.
    Example: 0
    CanEcmpFlag no no Int64 Whether ECMP is supported. Default value: 1, indicating that ECMP is supported.
    Example: 1

    VpcOssRouteForUpdateRouteWeightInternal

    Complex type: VpcOssRouteForUpdateRouteWeightInternal.

    Referenced by the following interfaces: UpdateRouteWeightInternal

    name required NULL allowed type description
    PrivateIp no no String Original VPC OSS APIv2 name: UpdateRouteWeight.pip.
    Example: 10.19.0.121
    ProtocolPort no no Int64 Original VPC OSS APIv2 name: UpdateRouteWeight.pport.
    Example: 8080
    Weight no no Int64 Original VPC OSS APIv2 name: UpdateRouteWeight.weight.
    Example: 10

    Tag

    Tag Key-value Pairs

    Referenced by the following interfaces: AllocateAddresses, CloneSecurityGroup, CreateAndAttachNetworkInterface, CreateAssistantCidr, CreateDefaultSecurityGroup, CreateDirectConnectGateway, CreateHaVip, CreateIpv6Routes, CreateNatGateway, CreateNetworkAcl, CreateNetworkInterface, CreateRouteTable, CreateRoutes, CreateSecurityGroup, CreateSecurityGroupWithPolicies, CreateSubnet, CreateSubnets, CreateVpc, DescribeAddresses, DescribeAssistantCidr, DescribeDirectConnectGateways, DescribeHaVips, DescribeIp6Addresses, DescribeNatGateways, DescribeNetworkAcls, DescribeNetworkInterfaces, DescribeNetworkInterfacesEx, DescribeNetworkInterfacesExtra, DescribeRouteTables, DescribeSecurityGroups, DescribeSubnets, DescribeVpcInternal, DescribeVpcPeeringConnections, DescribeVpcs, ModifyAssistantCidr

    name required NULL allowed type description
    Key yes yes String Tag Key
    Example: tag-key
    Value yes yes String Tag Value
    Example: tag-value

    ItemPrice

    Unidirectional Billing Price Information

    Referenced by the following interfaces: InquiryPriceCreateVpcPeerConnection, InquiryPriceCreateVpnGateway, InquiryPriceNatGateway, InquiryPriceResetVpnGatewayInternetMaxBandwidth, InquiryPriceUpdateCcnBandwidth

    name required NULL allowed type description
    UnitPrice no no Float Unit price of Pay-as-you-go (postpaid) billing mode, with the unit being USD.
    Example: 1.0
    ChargeUnit no no String Pay-as-you-go (postpaid) billing unit. The value range is as follows. HOUR: Indicates the billing unit is hour. Scenarios involving this billing unit include instance postpaid by hour (POSTPAID_BY_HOUR), and bandwidth postpaid by hour (BANDWIDTH_POSTPAID_BY_HOUR). GB: Indicates the billing unit is GB. Scenarios involving this billing unit include traffic postpaid by hour (TRAFFIC_POSTPAID_BY_HOUR).
    Example: HOUR
    OriginalPrice no no Float Original price of prepaid product, with the unit being USD.
    Example: 1.0
    DiscountPrice no no Float Discounted price for prepaid products, with the unit being USD.
    Example: 0.5

    DellRoute

    Delete Routing Policy Object

    Referenced by the following interfaces: DeleteRoutes

    name required NULL allowed type description
    RouteId no no Uint64 Route Object
    Example: 167
    RouteDescription no no String Routing policy description.
    Example: demo
    Enabled no no Bool Enable/Disable
    Example: true
    RouteType no no String Route type. Types supported currently are as follows. USER: User route; NETD: Network probe route, which is automatically issued by the system when creating a network probe instance, and cannot be edited or deleted; CCN: CCN route, which is automatically issued by the system, and cannot be edited or deleted. Users can only add and operate USER type routes.
    Example: NETD
    RouteTableId no no String Route table instance ID, e.g., rtb-azd4dt1c.
    Example: rtb-azd4dt1c
    RouteItemId no no String Routing policy string ID.
    Example: rule-azd4dt1c

    EipStatistics

    Structure Describing EIP Statistical Information

    Referenced by the following interfaces: DescribeEipStatistics

    name required NULL allowed type description
    Region yes no String English Identifier of Region
    Example: sz
    RegionName yes no String Region
    Example: sz
    TotalCount yes no Int64 Total Number of Region EIP
    Example: 10

    AddressInfo

    IP address template information

    Referenced by the following interfaces: CreateAddressTemplate

    name required NULL allowed type description
    Address yes no String IP address.
    Example: 2.2.2.2
    Description no no String Remarks.
    Example: desc
    UpdatedTime no no String Update time.
    Example: 2020-08-10 18:10:12

    AssistantCidr

    VPC's auxiliary CIDR information.

    Referenced by the following interfaces: CreateAssistantCidr, CreateVpc, DescribeAssistantCidr, DescribeVpcInternal, DescribeVpcs, ModifyAssistantCidr

    name required NULL allowed type description
    VpcId yes no String VPC instance ID, e.g., vpc-6v2ht8q5.
    Example: vpc-napeigw5
    CidrBlock yes no String Auxiliary CIDR, e.g., 172.16.0.0/16.
    Example: 192.241.0.0/24
    AssistantType yes no Int64 Auxiliary CIDR type (0: Normal auxiliary CIDR, 1: Container auxiliary CIDR). The default is 0.
    Example: 0: 'NORMAL', 1: 'DOCKER'
    SubnetSet yes yes Array of Subnet Subnets split by auxiliary CIDR.
    Example:View
    Region no no String Region information.
    Example: sz

    CcnInstance

    CCN associated instance object.

    Referenced by the following interfaces: AcceptAttachCcnInstances, AttachCcnInstances, DetachCcnInstances, RejectAttachCcnInstances

    name required NULL allowed type description
    InstanceType no no String Associated instance type, options:
  • VPC: Virtual Private Cloud
  • DIRECTCONNECT: Direct Connect gateway
  • BMVPC: BM VPC.

    • Example: VPC
    InstanceId yes no String Associated instance ID.
    Example: vpc-lt6ork07
    InstanceRegion yes no String Region of the associated instance ID. For example, ap-region.
    Example: ap-region

    VpcOssRoute

    Complex type: VpcOssRoute.

    Referenced by the following interfaces: DescribeServiceByRealServerInternal

    name required NULL allowed type description
    HostIp no no String Original VPC OSS APIv2 name: GetServiceByRs.hostIp.
    Example: 0.0.0.0
    PrivateIp no no String Original VPC OSS APIv2 name: GetServiceByRs.pip.
    Example: 10.112.65.50
    Weight no no Int64 Original VPC OSS APIv2 name: GetServiceByRs.weight.
    Example: 16
    PrivatePort no no Int64 Original VPC OSS APIv2 name: GetServiceByRs.privatePort.
    Example: 443
    ZoneId no no Int64 Original VPC OSS APIv2 name: GetServiceByRs.zoneId.
    Example: 50001
    UdpOption no no Int64 Original VPC OSS APIv2 name: GetServiceByRs.udpOption.
    Example: 0

    ZoneInfo

    EIP Availability Zone List Information

    Referenced by the following interfaces: DescribeAvailableZone

    name required NULL allowed type description
    Zone yes no String Availability zone name. For example, ap-region-1.
    Example: ap-region-2
    ZoneName yes no String Availability zone description. For example, Zone 1.
    Example: ap-region-2
    ZoneId yes no Int64 Availability Zone ID
    Example: 50001
    ZoneState yes no String Availability zone status, currently including only two statuses: UNAVAILABLE and AVAILABLE.
    Example: UNAVAILABLE

    ZoneSet

    Zone Array

    Referenced by the following interfaces: DescribeNatGatewayZones

    name required NULL allowed type description
    Zone yes yes String Zone Name
    Example: ap-region-2
    ZoneId yes no Uint64 Availability Zone ID
    Example: 50001

    DfwOssDeleteUSGRuleRequest

    Complex type: DfwOssDeleteUSGRuleRequest.

    Referenced by the following interfaces: DeleteUSGRuleInternal

    name required NULL allowed type description
    Indexes no no Array of Int64 Name of the original DFW API (v2): deleteUSGRule.indexes.
    Example: [1, 2]
    UsgId no no String Name of the original DFW API (v2): deleteUSGRule.usgId.
    Example: 123123
    Direction no no String Name of the original DFW API (v2): deleteUSGRule.direction.
    Example: inbound
    Version no no Int64 Name of the original DFW API (v2): deleteUSGRule.version.
    Example: 12

    NetworkAcl

    Network ACL

    Referenced by the following interfaces: CreateNetworkAcl, DescribeNetworkAcls

    name required NULL allowed type description
    VpcId yes no String VPC instance ID.
    Example: vpc-q26u781x
    NetworkAclId yes no String Network ACL instance ID.
    Example: acl-fy0ys38q
    NetworkAclName yes no String Network ACL name, up to 60 bytes in length.
    Example: demo
    CreatedTime yes no String Creation time.
    Example: 2021-03-22 20:59:55
    SubnetSet yes no Array of Subnet Network ACL associated subnet array.
    Example:View
    IngressEntries yes no Array of NetworkAclEntry Network ACL inbound rules.
    Example:View
    EgressEntries yes no Array of NetworkAclEntry Network ACL outbound rules.
    Example:View

    DfwOssDeletePolicyFromVmRequest

    Complex type: DfwOssDeletePolicyFromVmRequest.

    Referenced by the following interfaces: DeletePolicyFromVmInternal

    name required NULL allowed type description
    Uuid no no String Name of the original DFW API (v2): delPolicyFromVM.uuid.
    Example: 123123
    Policies no no Array of DfwOssPolicies Name of the original DFW API (v2): delPolicyFromVM.policies.
    Example:View

    InternetPriceDetail

    Public IP Inquiry Output Parameters

    Referenced by the following interfaces: InquiryPriceAllocateAddresses

    name required NULL allowed type description
    UnitPrice no no Float Unit price, unit:USD.
    Example: 1
    DiscountPrice no no Float Discounted unit price, unit: USD.
    Example: 1
    ChargeUnit no no String Billing unit. The value range is as follows. HOUR: Indicates that the billing unit is calculated hourly. The scenarios currently involving this billing unit include TRAFFIC_POSTPAID_BY_HOUR and BANDWIDTH_POSTPAID_BY_HOUR. MONTH: Indicates that the billing unit is calculated monthly. The scenarios currently involving this billing unit include: BANDWIDTH_POSTPAID_BY_MONTH, BANDWIDTH_PREPAID_BY_MONTH, and BANDWIDTH_PACKAGE.
    Example: HOUR

    TrafficMirrorTarget

    Traffic Mirror Collection Target Type

    Referenced by the following interfaces: CreateTrafficMirror, DescribeTrafficMirrors, ResetTrafficMirrorTarget

    name required NULL allowed type description
    TargetIps yes no Array of String Receiving IP of Traffic Mirror
    Example: ["10.0.0.0"]
    AlgHash yes no String Traffic mirror receiver IP group. Load balancing rule. ENI/FIVE_TUPLE_FLOW supported.
    Example: FIVE_TUPLE_FLOW

    LocalSourceIpPortTranslationAclRuleNeedId

    Local Source IP Port Translation ACL Mapping Rules

    Referenced by the following interfaces: ModifyLocalSourceIpPortTranslationAclRule

    name required NULL allowed type description
    Protocol yes no String Protocol
    Example: tcp
    SourceCidr yes no String Source Address
    Example: 1.1.1.0/16
    SourcePort yes no String Source Port
    Example: 80
    DestinationCidr yes no String Destination address
    Example: 2.2.2.0/16
    DestinationPort yes no String Destination port
    Example: 80
    Action no no Int64 Action. 0: Allow, 1: Reject.
    Example: 0
    AclRuleId yes no Int64 ACL Rule ID
    Example: 100

    EIPIspInfo

    EIP ISP Information

    Referenced by the following interfaces: DescribeEIPIspInfo

    name required NULL allowed type description
    Type yes no String ISP Type
    CTCC
    CUCC
    CMCC
    BGP
    Example: CTCC
    Name yes no String ISP Name
    Example: ISP Name
    Id no no Int64 ISP ID.
    Example: 5
    IspStatus no no Int64 IPv4 ISP status.
    Example: 1
    IspStatusIPv6 no no Int64 IPv6 ISP status.
    Example: 1
    DefaultIsp no no Int64 Whether it is an IPv4 default ISP.
    Example: 1
    V4Alias no yes String IPv4 alias
    Example: name
    V6Alias no yes String IPv6 alias.
    Example: name

    QuotaSet

    Quota Information

    Referenced by the following interfaces: DescribeAddressAssociationQuota

    name required NULL allowed type description
    QuotaId no yes String Quota ID.
    Example: NETWORK_INTERFACE_ADDRESS_ASSOCIATION
    NetworkInterfaceId no yes String network interface card ID
    Example: eni-2dr67vs9
    QuotaCurrent no yes Int64 Used quota
    Example: 2
    QuotaLimit no yes Int64 Total quota
    Example: 10
    DefaultInternetServiceProvider no yes Bool Default
    Example: true

    VpcOssRouteInfoRequest

    Complex type: VpcOssRouteInfoRequest.

    Referenced by the following interfaces: CreateRouteInternal, DeleteRouteInternal

    name required NULL allowed type description
    RouteSet no no Array of VpcOssRouteForDeleteRouteInternal Original VPC OSS APIv2 name: DelRoute.route.
    Example:View
    VpcId no no Int64 Integer VPCID.
    Example: 1
    UniqueVpcId no no String The externally unique VPCID.
    Example: vpc-jmaywf6r
    GroupId no no Int64 Original VPC OSS APIv2 name: DelRoute.groupId.
    Example: 0
    Type no no Int64 Original VPC OSS APIv2 name: DelRoute.type.
    Example: 0
    Protocol no no String Original VPC OSS APIv2 name: DelRoute.proto.
    Example: tcp
    VirtualPort no no Int64 Original VPC OSS APIv2 name: DelRoute.vport.
    Example: 22
    Vip no no String Original VPC OSS APIv2 name: DelRoute.vip.
    Example: 172.16.0.18

    Subnet

    Subnet Object

    Referenced by the following interfaces: CreateAssistantCidr, CreateNetworkAcl, CreateSubnet, CreateSubnets, CreateVpc, DescribeAssistantCidr, DescribeNetworkAcls, DescribeSubnets, DescribeVpcInternal, DescribeVpcs, ModifyAssistantCidr

    name required NULL allowed type description
    VpcId yes no String VPC instance ID.
    Example: vpc-m0c2kcun
    SubnetId yes no String Subnet instance ID, e.g., subnet-bthucmmy.
    Example: subnet-bthucmmy
    SubnetName yes no String Subnet name.
    Example: demo
    CidrBlock yes no String IPv4 CIDR of Subnet.
    Example: 10.0.0.0/24
    IsDefault yes no Bool Whether it is the default subnet.
    Example: true
    EnableBroadcast yes no Bool Whether to enable broadcast.
    Example: true
    Zone yes no String Availability zone.
    Example: region
    RouteTableId no no String Route table instance ID, e.g., rtb-l2h8d7c2.
    Example: rtb-l2h8d7c2
    CreatedTime no no String Creation time.
    Example: 2018-04-04T10:15:16+08:00
    AvailableIpAddressCount yes no Uint64 Number of available IP.
    Example: 254
    Ipv6CidrBlock no no String Subnet's IPv6 CIDR.
    Example: 3402:4e00:20:1200::/64
    NetworkAclId no no String Associated ACL ID
    Example: acl-l2h8d7c2
    IsRemoteVpcSnat no no Bool Whether it is a SNAT address pool subnet.
    Example: true
    TotalIpAddressCount yes no Uint64 Total IP count within the subnet.
    Example: 254
    TagSet yes no Array of Tag Tag key-value pairs.
    Example:View
    Type no no Uint64 Subnet type.
    Example: 0/9
    VmNum no yes Uint64 Number of VMs.
    Example: 2
    ZoneId no yes Uint64 Availability zone ID.
    Example: 50001
    LocalZone no no Bool Whether it is a local region.
    Example: 1
    IsCdcSubnet no no Uint64 Whether it is a CDC-controlled subnet.
    Example: 0
    CdcId no no String CDC ID
    Example: cluster-gbo27yc4
    BmsNum no no Uint64 Bare Metal Quantity
    Example: 2
    IsShare no no Bool Whether it is a shared resource.
    Example: True
    Region no no String Region.
    Example: sz

    VpcOssServiceRequest

    Complex type: VpcOssServiceRequest.

    Referenced by the following interfaces: DeleteServiceInternal

    name required NULL allowed type description
    VirtualPort no no Int64 Original VPC OSS APIv2 name: DelService.vport.
    Example: 22
    Sip no no String Original VPC OSS APIv2 name: DelService.sip.
    Example: 1.1.1.1
    GroupId no no Int64 Original VPC OSS APIv2 name: DelService.groupId.
    Example: 1
    VpcId no no Int64 Integer VPCID.
    Example: 1
    UniqueVpcId no no String The externally unique VPCID.
    Example: vpc-jmaywf6r
    Type no no Int64 Original VPC OSS APIv2 name: DelService.type.
    Example: 0
    Protocol no no String Original VPC OSS APIv2 name: DelService.proto.
    Example: tcp
    Vip no no String Original VPC OSS APIv2 name: DelService.vip.
    Example: 172.16.0.18
    RemoteVpcId no no Int64 Original VPC OSS APIv2 name: DelService.remoteVpcId.
    Example: 1
    DeleteRouteFlag no no Int64 Original VPC OSS APIv2 name: DelService.bDelRoute.
    Example: 0

    AddressBase

    EIP Basic Information

    Referenced by the following interfaces: DescribeAddressSet

    name required NULL allowed type description
    InternetServiceProvider yes no String ISP, including Mobile, Unicom, Telecom, and cloud platform CAP.
    Example: BGP
    SetName yes no String EIP Cluster Name
    Example: demo
    SetId yes no Int64 Unique ID of EIP Cluster
    Example: 24523
    AddressIp yes no String EIP Address
    Example: 10.23.32.2
    IsDpdk yes no Bool Whether EIP supports DPDK.
    Example: True
    Status yes no String Whether the EIP is available.
    Example: Used

    InstanceStatistic

    For Description of the Statistical Information of Instance

    Referenced by the following interfaces: DescribeSecurityGroupAssociationStatistics

    name required NULL allowed type description
    InstanceType yes no String Instance Type
    Example: CVM
    InstanceCount yes no Uint64 Number of Instances
    Example: 10

    Route

    Routing Policy Object

    Referenced by the following interfaces: CreateIpv6Routes, CreateRouteTable, CreateRoutes, DeleteIpv6Routes, DeleteRoutes, DescribeRouteConflicts, DescribeRouteTables, DescribeRoutes, DescribeRoutesWithLocal, ModifyIpv6Routes, ReplaceRoutes, ResetRoutes

    name required NULL allowed type description
    RouteId no no Uint64 Routing policy ID.
    Example: 1289089
    DestinationCidrBlock no no String Destination IP range. The value must not be within the VPC IP range, e.g.: 112.20.51.0/24.
    Example: 10.0.0.0/24
    GatewayType no no String Type of next hop. The types supported currently are
    CVM: Public network gateway type CVM;
    VPN: VPN gateway;
    DIRECTCONNECT: Direct Connect gateway;
    PEERCONNECTION: Peering connection;
    SSLVPN: sslvpn gateway;
    NAT: NAT gateway;
    NORMAL_CVM: Ordinary CVM;
    EIP: Public IP of CVM;
    CCN: CCN.
    Example: VPN
    GatewayId no no String Next hop address: only the gateway ID of different next hop types needs to be specified, and the system will automatically match the next hop address.
    Special note: When GatewayType is EIP, GatewayId has a fixed value '0'.
    Example: vpn-acxun9p
    RouteDescription no no String Routing policy description.
    Example: demo
    Enabled no no Bool Enable/Disable
    Example: true
    RouteType no no String Route type currently supported:
    USER: User route;
    NETD: Network probe route, automatically issued by the system when creating a network probe instance, and cannot be edited or deleted;
    CCN: CCN route, automatically issued by the system, and cannot be edited or deleted.
    Users can only add and manage USER type routes.
    Example: USER
    RouteTableId no no String Route table instance ID, e.g., rtb-azd4dt1c.
    Example: rtb-azd4dt1c
    RouteItemId no no String Routing policy string ID.
    Example: rti-9bjer08h
    DestinationIpv6CidrBlock no no String Create a destination IPv4 CIDR, and the value cannot be within the VPC CIDR. For example: 112.20.51.0/24.
    Example: 10.0.0.0/24
    CreatedTime no no Datetime Routing policy creation time.
    Example: 2021-03-02 14:41:15
    IsCdc no no String Whether it is a CDC route.
    Example: true
    PublishedToVbc no no Bool Whether the routing policy is published to CCN. This field is only used as an output parameter and is invalid when used as an input parameter.
    Example: true
    SubnetRouteAlgorithm no no String Supported ECMP algorithms: ECMP_QUINTUPLE_HASH: five tuple hash; ECMP_SOURCE_DESTINATION_IP_HASH: source and target IP address hash; ECMP_DESTINATION_IP_HASH: target IP address hash; ECMP_SOURCE_IP_HASH: source IP address hash.
    Example: ECMP_SOURCE_DESTINATION_IP_HASH
    CdcId no no String cluster-d8htgb6k
    Example: Unique ID of the CDC cluster

    TrafficMirrorFilter

    Quintuple Filter Rule Object for Traffic Mirror

    Referenced by the following interfaces: CreateTrafficMirror, DescribeTrafficMirrors, ResetTrafficMirrorFilter, UpdateTrafficMirrorAllFilter

    name required NULL allowed type description
    SrcNet yes no String Source IP Range of the Filtering Rule
    Example: 10.0.0.0/24
    DstNet yes no String Destination IP Range of the Filtering Rule
    Example: 192.168.0.0/24
    SrcPort no no String Source port of the filtering rules. The default value is 1-65,535.
    Example: 5000
    DstPort no no String Destination port of filter rules. Default: 1-65535.
    Example: 3456
    Protocol yes no String Protocol of the Filtering Rules
    Example: ALL

    EndPoint

    Endpoint details.

    Referenced by the following interfaces: CreateVpcEndPoint, CreateVpcEndPointService, DescribeVpcEndPoint, DescribeVpcEndPointService

    name required NULL allowed type description
    EndPointId yes no String Terminal node ID.
    Example: vpce-7czfogk8
    VpcId yes no String VPCID.
    Example: vpc-67wlqf6v
    SubnetId yes no String Subnet ID.
    Example: subnet-8qywqc4y
    EndPointOwner yes no String APPID.
    Example: jkt45567
    EndPointName yes no String Endpoint name.
    Example: demo
    ServiceVpcId yes no String VPCID of terminal node service.
    Example: vpc-67wlqf6v
    ServiceVip yes no String VIP of endpoint service.
    Example: 10.23.11.12
    EndPointServiceId yes no String ID of endpoint service.
    Example: vpcsvc-demoag78
    EndPointVip yes no String VIP of endpoints.
    Example: 10.23.11.12
    State yes no String Endpoint statuses. ACTIVE: Available, PENDING: Pending, ACCEPTING: Accepting, REJECTED: Rejected, FAILED: Failed.
    Example: 0/1/2/3/4
    CreateTime yes no String Creation time.
    Example: 2018-06-21 11:32:29
    GroupSet no no Array of String Security group instance ID list bound to the endpoint.
    Example: ['sg-demoag78']
    ServiceName no no String Endpoint service name.
    Example: demo
    IpAddressType no no String Address Type
    Example: IPv4/IPv6

    VpcEndPointServiceUser

    Details on the allowlist object of endpoint services.

    Referenced by the following interfaces: DescribeVpcEndPointServiceWhiteList

    name required NULL allowed type description
    Owner yes no Uint64 AppId.
    Example: 1255000100
    UserUin yes no String Uin.
    Example: jkt
    Description yes no String Description information.
    Example: demo
    CreateTime yes no String Creation Time
    Example: 2021-01-14 15:58:40
    EndPointServiceId yes no String Endpoint service ID.
    Example: vpcsvc-b2mrmmx7

    DfwOssGetUSGCountFromSGResult

    Complex type: DfwOssGetUSGCountFromSGResult.

    Referenced by the following interfaces: DescribeUSGCountFromSgInternal

    name required NULL allowed type description
    SgId no no String Name of the original DFW API (v2): getUSGCountFromSG.sgId.
    Example: 251197522
    USGCount no no Int64 Name of the original DFW API (v2): getUSGCountFromSG.uSGCount.
    Example: 17

    VpcOssDocker

    Complex type: VpcOssDocker.

    Referenced by the following interfaces: DescribeDockerInternal, DescribeDockerSubnetInternal

    name required NULL allowed type description
    Mask no no String Mask
    Example: 255.255.0.0
    IntMask no no Int64 Integer mask.
    Example: 16
    CreateTime no no String Name of the original VPC OSS API (v2): GetDockerSubnet.createTime.
    Example: 2021-12-28 16:42:40
    Subnet no no String Subnet address
    Example: 10.0.0.0
    VpcId no no Int64 Integer VPCID.
    Example: 78257
    UniqueVpcId no no String The externally unique VPCID.
    Example: vpc-jmaywf6r

    ServiceTemplateSpecification

    Protocol Port Template

    Referenced by the following interfaces: CreateSecurityGroupPolicies, CreateSecurityGroupWithPolicies, DeleteSecurityGroupPolicies, DescribeSecurityGroupPolicies, DescribeSecurityGroupPolicyTemplates, ModifySecurityGroupPolicies, ReplaceSecurityGroupPolicy

    name required NULL allowed type description
    ServiceId yes no String Protocol port ID, e.g., ppm-f5n1f8da.
    Example: ppm-f5n1f8da
    ServiceGroupId yes no String Protocol port group ID, e.g., ppmg-f5n1f8da.
    Example: ppmg-f5n1f8da

    SubnetInput

    Subnet Object

    Referenced by the following interfaces: CreateSubnets

    name required NULL allowed type description
    CidrBlock yes no String Subnet CIDR.
    Example: 192.241.0.0/24
    SubnetName yes no String Subnet name.
    Example: demo
    Zone yes no String Availability zone. For example,ap-region-2.
    Example: 50001
    RouteTableId no no String Designated associated route table, e.g., rtb-3ryrwzuu.
    Example: rtb-q8o2z892
    Type no no Uint64 Specify the subnet type to be created.
    Example: 0

    VpcOssNewService

    Complex type: VpcOssNewService.

    Referenced by the following interfaces: CreateServiceInternal

    name required NULL allowed type description
    UniqueVpcGatewayId no no String Original VPC OSS APIv2 name: AddService.uniqVpcgwId.
    Example: vpcgw-7hk7255d
    VpcGatewayZoneId no no Int64 Original VPC OSS APIv2 name: AddService.vpcgwZoneId.
    Example: 1002
    Sip no no String Original VPC OSS APIv2 name: AddService.sip.
    Example: 1.1.1.1
    SubnetRouteAlgorithm no no Int64 Original VPC OSS APIv2 name: AddService.subnetRouteAlgorithm.
    Example: 0
    FakeToaIp no yes String Original VPC OSS APIv2 name: AddService.fakeToaIp.
    Example: 192.168.0.1
    Vip no no String Original VPC OSS APIv2 name: AddService.vip.
    Example: 172.16.0.18
    StickyTimeout no no Int64 Original VPC OSS APIv2 name: AddService.stickyTimeout.
    Example: 0
    RouteGroupId no no Int64 Original VPC OSS APIv2 name: AddService.routeGroupId.
    Example: 1
    Type no no Int64 Original VPC OSS APIv2 name: AddService.type.
    Example: 0
    Protocol no no String Original VPC OSS APIv2 name: AddService.proto.
    Example: tcp
    RemoteVpcId no no Int64 Original VPC OSS APIv2 name: AddService.remoteVpcId.
    Example: 1
    VpcGatewayType no no Int64 Original VPC OSS APIv2 name: AddService.vpcGwType.
    Example: 1
    StickyFlag no no Int64 Original VPC OSS APIv2 name: AddService.stickyFlag.
    Example: 0
    LbType no no Int64 Original VPC OSS APIv2 name: AddService.lbType.
    Example: 0
    ResetFlag no no Int64 Original VPC OSS APIv2 name: AddService.rstFlag.
    Example: 0
    NoSnatFlag no no Int64 Original VPC OSS APIv2 name: AddService.noSnatFlag.
    Example: 0
    BypassFlag no no Int64 Original VPC OSS APIv2 name: AddService.bypassFlag.
    Example: 0
    Business no no String Original VPC OSS APIv2 name: AddService.business.
    Example: dockerMaster
    GroupId no yes Int64 Original VPC OSS APIv2 name: AddService.groupId.
    Example: 1
    VpcId no no Int64 Integer VPCID.
    Example: 1
    VirtualPort no no Int64 Original VPC OSS APIv2 name: AddService.vport.
    Example: 22
    UniqueClassicVpcGatewayId no no String Original VPC OSS APIv2 name: AddService.uniqClassicVpcgwId.
    Example: vpcgw-7hk70tq
    VpcGatewayAttrFlag no no Int64 Original VPC OSS APIv2 name: AddService.bVpcgwAttrFlag.
    Example: 0
    StickyMaxCount no no Int64 Original VPC OSS APIv2 name: AddService.stickyMaxCount.
    Example: 0
    RouteSet no no Array of VpcOssRouteForDeleteRouteInternal Original VPC OSS APIv2 name: AddService.route.
    Example:View
    DelPipRouteFlag no no Int64 Original VPC OSS APIv2 name: AddService.bDelPipRoute.
    Example: 0
    VipVpcGatewayId no no String Original VPC OSS APIv2 name: AddService.uniqVpcGwIpVpcgwId.
    Example: vpcgw-7hk7255d
    VpcGatewayIp no no String Original VPC OSS APIv2 name: AddService.vpcGwIp.
    Example: 1.1.1.1
    UniqueRouteGroupId no no String Original VPC OSS APIv2 name: AddService.uniqRouteGroupId.
    Example: vpcgw-7hk7255d
    CdcFlag no no Int64 Original VPC OSS APIv2 name: AddService.bCdc.
    Example: 0
    UniqueVpcId no no String The externally unique VPCID.
    Example: vpc-jmaywf6r
    RouteGroupFlag no no Int64 Original VPC OSS APIv2 name: AddService.routeGroupFlag.
    Example: 0
    UniqueCdcId no no String Original VPC OSS APIv2 name: AddService.uniqCdcId.
    Example: cluster-pwqp4055

    VpcOssRouteForDeleteRouteInternal

    Complex type: VpcOssRouteForDeleteRouteInternal.

    Referenced by the following interfaces: CreateRouteInternal, CreateServiceInternal, DeleteRouteInternal

    name required NULL allowed type description
    PrivateIp no no String Original VPC OSS APIv2 name: DelRoute.pip.
    Example: 10.19.0.121
    ProtocolPort no no Int64 Original VPC OSS APIv2 name: DelRoute.pport.
    Example: 8080
    Weight no no Int64 Original VPC OSS APIv2 name: DelRoute.weight.
    Example: 10
    ZoneId no no Int64 Original VPC OSS APIv2 name: DelRoute.zoneId.
    Example: 50001
    UdpOption no no Int64 Original VPC OSS APIv2 name: DelRoute.udpOption.
    Example: 1
    HostIp no no String Original VPC OSS APIv2 name: DelRoute.hostIp.
    Example: 1.1.1.1

    IKEOptionsSpecification

    IKE (Internet Key Exchange) configuration, which involves a set of self-protection mechanisms for user-configured network security protocols.

    Referenced by the following interfaces: CreateVpnConnection, DescribeVpnConnections, ModifyVpnConnectionAttribute

    name required NULL allowed type description
    PropoEncryAlgorithm no no String Encryption algorithms. Options: '3DES-CBC', 'AES-CBC-128', 'AES-CBS-192', 'AES-CBC-256', and 'DES-CBC'. Default: 3DES-CBC.
    Example: 3DES-CBC
    PropoAuthenAlgorithm no no String Authentication algorithm. Options: MD5, and SHA1. The default is MD5.
    Example: MD5
    ExchangeMode no no String Negotiation mode. Options: AGGRESSIVE and MAIN. The default is MAIN.
    Example: MAIN
    LocalIdentity no no String Local identifier type. Options are ADDRESS and FQDN, ADDRESS by default.
    Example: ADDRESS
    RemoteIdentity no no String Peer identifier type: options include: 'ADDRESS', 'FQDN'. Default: ADDRESS.
    Example: ADDRESS
    LocalAddress no no String Local identifier. When LocalIdentity is selected as ADDRESS, LocalAddress is required. The default localAddress is the public IP of VPN gateway.
    Example: 1.2.3.4
    RemoteAddress no no String Peer identifier. When RemoteIdentity is set to ADDRESS, RemoteAddress is required.
    Example: 4.3.2.1
    LocalFqdnName no no String Local identifier. When LocalIdentity is selected as FQDN, LocalFqdnName is required.
    Example: LocalName
    RemoteFqdnName no no String Customer identifier. When remoteIdentity is selected as FQDN, RemoteFqdnName is required.
    Example: RemoteName
    DhGroupName no no String DH group, specifying the DH group used in key exchange (IKE). Options: GROUP1, GROUP2, GROUP5, GROUP14, and GROUP24,
    Example: GOURP1
    IKESaLifetimeSeconds no no Uint64 IKE SA lifetime, in seconds. It sets the lifespan of IKE SA, value range: 60-604,800.
    Example: 60
    IKEVersion no no String IKE Version
    Example: 1

    RouteConflict

    Route Conflict Object

    Referenced by the following interfaces: DescribeRouteConflicts

    name required NULL allowed type description
    RouteTableId yes no String Route table instance ID, e.g., rtb-azd4dt1c.
    Example: rtb-q8o2z892
    DestinationCidrBlock yes no String Conflicting Destination Port to be Checked
    Example: 192.241.0.0/24
    ConflictSet yes no Array of Route Conflicting Routing Policy List
    Example:View

    AddressTemplateSpecification

    IP Address Template

    Referenced by the following interfaces: CreateSecurityGroupPolicies, CreateSecurityGroupWithPolicies, DeleteSecurityGroupPolicies, DescribeSecurityGroupPolicies, DescribeSecurityGroupPolicyTemplates, ModifySecurityGroupPolicies, ReplaceSecurityGroupPolicy

    name required NULL allowed type description
    AddressId yes no String IP address ID, e.g., ipm-2uw6ujo6.
    Example: ipm-2uw6ujo6
    AddressGroupId yes no String IP address group ID, e.g., ipmg-2uw6ujo6.
    Example: ipmg-2uw6ujo6

    SecurityGroupAssociationStatistics

    Statistics of Instances Associated with Security Group

    Referenced by the following interfaces: DescribeSecurityGroupAssociationStatistics

    name required NULL allowed type description
    SecurityGroupId yes no String Security group instance ID.
    Example: sg-o62agjal
    CVM yes no Uint64 CVM instance count.
    Example: 2
    CDB yes no Uint64 Database instance count.
    Example: 2
    ENI yes no Uint64 ENI instance count.
    Example: 2
    SG yes no Uint64 Number of references by security groups.
    Example: 2
    CLB yes no Uint64 Number of CLB instances.
    Example: 2
    InstanceStatistics yes no Array of InstanceStatistic Full instance binding statistics.
    Example:View
    TotalCount yes no Uint64 Total count of all resources (excluding those referenced by security groups).
    Example: 10

    IdcSet

    NAT64 IDC information.

    Referenced by the following interfaces: DescribeIp6IdcInfo

    name required NULL allowed type description
    RegionId no no Int64 RegionId
    Example: 50090001
    RegionName no no String RegionName
    Example: cq
    ZoneId no no Int64 ZoneId
    Example: 50090001
    ZoneName no no String ZoneName
    Example: cq
    IdcId no no Int64 IdcId
    Example: 50080005
    IdcName no no String IdcName
    Example: iaasidc

    CidrDetailSet

    Non-standard IP Range Type

    Referenced by the following interfaces: DescribeNmsCidrs

    name required NULL allowed type description
    AddrSegment no no String Non-standard IP Range Address
    Example: 10.0.0.0/8
    AddressType no no String Network Type
    Example: Overlay
    CreateTime no no Datetime Creation Time
    Example: 2024-05-22 11:58:26
    IsReserved no no Uint64 Whether it is a reserved address.
    Example: 0
    Ver no no String Address type
    Example: IPv4

    VpcOssVpcPeerRequest

    Complex type: VpcOssVpcPeerRequest.

    Referenced by the following interfaces: UpdateVpcPeerInternal

    name required NULL allowed type description
    State no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.state.
    Example: 0
    Bandwidth no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.bandwidth.
    Example: 0
    OwedFlag no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.owedFlag.
    Example: 0
    UniqueVpcPeerId no no String Name of the original VPC OSS API (v2): UpdateVpcPeer.uniqVpcPeerId.
    Example: pcx-fh7xs34s
    VpcPeerId no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.vpcPeerId.
    Example: 2
    Owner no no String User app ID
    Example: 251198225
    Name no no String Name
    Example: 11
    VirtualSafeGroupIp no no String Name of the original VPC OSS API (v2): UpdateVpcPeer.vsgIp.
    Example: 1.2.3.5
    NewAfcFlag no no Int64 Name of the original VPC OSS API (v2): UpdateVpcPeer.bNewAfc.
    Example: 1
    PublishDockerCidrFlag no no Uint64 Name of the original VPC OSS API (v2): UpdateVpcPeer.bPublishDockerCidr.
    Example: 0

    LocalIpTranslationAclRule

    Local IP Translation ACL Rule Complex Type

    Referenced by the following interfaces: CreateLocalIpTranslationAclRule, DescribeLocalIpTranslationAclRules

    name required NULL allowed type description
    Protocol yes no String Protocol
    Example: tcp
    SourcePort yes no String Source Port
    Example: 80
    DestinationCidr yes no String Destination IP
    Example: 1.1.1.0/16
    DestinationPort yes no String Destination port
    Example: 80
    Action no no Int64 0 or 1
    Example: 0
    AclRuleId no no Int64 ACL Rule ID
    Example: 26

    HaVipAssociation

    CVM instance or ENI bound to HAVIP (used to limit the scope of HAVIP switching, which does not trigger a real switch operation).

    Referenced by the following interfaces: CreateHaVip, DescribeHaVips

    name required NULL allowed type description
    InstanceId yes no String Unique ID of the instance or ENI bound to HAVIP.
    Example: ins-3qx9elib
    HaVipId no no String Unique instance ID of HAVIP.
    Example: havip-7tqt5jn6
    InstanceType no no String Type of the object bound to HAVIP. Valid values: CVM and ENI.
    Example: CVM

    Ip6Rule

    IPv6 Translation Rules

    Referenced by the following interfaces: DescribeIp6Translators

    name required NULL allowed type description
    Ip6RuleId yes no String Unique ID of the IPv6 translation rule, such as rule6-7v3vwgec.
    Example: rule6-7v3vwgec
    Ip6RuleName yes no String Name of IPV6 Conversion Rules
    Example: demo
    Vip6 yes no String IPv6 Address
    Example: 3402:4e00:20:1200::/64
    Vport6 yes no Int64 IPv6 Port Number
    Example: 443
    Protocol yes no String Protocol type, supporting TCP/UDP.
    Example: TCP
    Vip yes no String IPv4 Address
    Example: 10.0.0.14
    Vport yes no Int64 IPv4 Port Number
    Example: 443
    RuleStatus yes no String Conversion rule status, limited to CREATING, RUNNING, DELETING, and MODIFYING.
    Example: RUNNING
    CreatedTime yes no Datetime_iso Translation Rule Creation Time
    Example: 2019-01-10T16:29:37

    DfwOssCreateUSGRequest

    Complex type: DfwOssCreateUSGRequest.

    Referenced by the following interfaces: CreateUSGInternal

    name required NULL allowed type description
    Sys no no Int64 Name of the original DFW API (v2): createUSG.sys.
    Example: 1
    SgId no no String Name of the original DFW API (v2): createUSG.sgId.
    Example: 123123
    UsgName no no String Name of the original DFW API (v2): createUSG.usgName.
    Example: test
    UsgRemark no no String Name of the original DFW API (v2): createUSG.usgRemark.
    Example: remark
    ProjectId no no String Name of the original DFW API (v2): createUSG.projectId.
    Example: 123
    Os no no Int64 Name of the original DFW API (v2): createUSG.os.
    Example: 1

    FilterObject

    Filter Key-Value Pair

    Referenced by the following interfaces: DescribeClassicLinkInstances, DescribeVpnGateways, DescribeVpnSellingModelTaglist

    name required NULL allowed type description
    Name yes no String Attribute name. When there are multiple Filters, the relationship between Filters is logical AND.
    Example: vpc-id
    Values yes no Array of String Attribute value. If multiple values exist for the same Filter, the relationship between values under the same Filter is logical OR.
    Example: ["vpc-pnpcflil"]

    VpcOssSubnet

    Complex type: VpcOssSubnet.

    Referenced by the following interfaces: DescribeRoutingTableListDetailInternal

    name required NULL allowed type description
    CdcFlag no no Int64 Name of the original VPC OSS API (v2): GetRtbListDetail.bCdc.
    Example: 0
    DefaultFlag no no Int64 Name of the original VPC OSS API (v2): GetRtbListDetail.bDefault.
    Example: 1
    UniqueCdcId no no String Name of the original VPC OSS API (v2): GetRtbListDetail.uniqCdcId.
    Example: cdc-asdqasd
    UniqueSubnetId no no String The externally unique SubnetId.
    Example: subnet-dbrazzr0
    DhcpFlag no no Int64 Name of the original VPC OSS API (v2): GetRtbListDetail.dhcpFlag.
    Example: 0
    Subnet no no String Subnet address
    Example: 172.16.0.0
    Name no no String Name
    Example: Default-Subnet
    Mask no no String Mask
    Example: 255.255.240.0
    ZoneId no no Int64 Name of the original VPC OSS API (v2): GetRtbListDetail.zoneId.
    Example: 100002
    IntMask no no Int64 Integer mask.
    Example: 20
    SubnetId no no Int64 Integer subnetId.
    Example: 1990867

    ReferredSecurityGroup

    Security Group Referenced Information

    Referenced by the following interfaces: DescribeSecurityGroupReferences

    name required NULL allowed type description
    SecurityGroupId yes no String Security group instance ID.
    Example: sg-pnpcflil
    ReferredSecurityGroupIds yes no Array of String All security group instance IDs with reference to security group instance ID (SecurityGroupId).
    Example: ["sg-nswq8wkq"]

    VpcOssVpcCidr

    Complex type: VpcOssVpcCidr.

    Referenced by the following interfaces: UpdateVpcAssistCidrInternal

    name required NULL allowed type description
    Owner no no String User app ID
    Example: 251198225
    Subnet no no String Subnet address
    Example: 172.16.0.0
    IntMask no no Int64 Integer mask.
    Example: 20
    OperationRouteToVbcFlag no no Int64 Name of the original VPC OSS API (v2): UpdateVpcAssistCidr.bOpRouteToVbc.
    Example: 1
    PublishVpgFlag no no Int64 Name of the original VPC OSS API (v2): bPublishVpg.
    Example: 1
    VpcId no no Int64 Integer VPCID.
    Example: 78257
    UniqueVpcId no no String The externally unique VPCID.
    Example: vpc-fjknwrrj

    AnycastRegionInfo

    Information on Regions that Support AnycastEIP

    Referenced by the following interfaces: DescribeAnycastRegion

    name required NULL allowed type description
    Region yes no String Region
    Example: ap-region
    RegionName yes no String Region
    Example: ap-region
    RegionState yes no String Current Status of Region
    Example: Used
    AnycastZone yes no String AnycastEIP Release Domain
    Example: ap-region-1

    TemplateLimit

    Parameter Template Quota

    Referenced by the following interfaces: DescribeTemplateLimits

    name required NULL allowed type description
    AddressTemplateMemberLimit yes no Uint64 Parameter template IP address member quota.
    Example: 2
    AddressTemplateGroupMemberLimit yes no Uint64 Quota for IP address group member of parameter template.
    Example: 2
    ServiceTemplateMemberLimit yes no Uint64 Parameter template I protocol port member quota.
    Example: 2
    ServiceTemplateGroupMemberLimit yes no Uint64 Member quota of parameter template protocol port group.
    Example: 2

    VpcOssNatService

    Complex type: VpcOssNatService.

    Referenced by the following interfaces: DeleteNatGatewayServiceInternal

    name required NULL allowed type description
    UniqueVpcId no no String The externally unique VPCID.
    Example: vpc-jmaywf6r
    GatewayIp no no String Name of the original VPC OSS API (v2): DelNatgwService.gwIp.
    Example: 9.241.203.205
    UniqueVpcGatewayIndex no no String Name of the original VPC OSS API (v2): DelNatgwService.uniqVgwIndex.
    Example: 172.16.0.18
    SubnetId no no Int64 Integer subnetId.
    Example: 1990866
    Owner no no String User app ID
    Example: 251198225
    UniqueSubnetId no no String The externally unique SubnetId.
    Example: subnet-am4aebsm
    PrivateIp no no String Name of the original VPC OSS API (v2): DelNatgwService.pip.
    Example: 172.16.0.18
    Business no no String Name of the original VPC OSS API (v2): DelNatgwService.business.
    Example: bus
    VpcGatewayIndex no no String Name of the original VPC OSS API (v2): DelNatgwService.vgwIndex.
    Example: 172.16.0.18
    BusinessOwner no no String Name of the original VPC OSS API (v2): DelNatgwService.businessOwner.
    Example: 123455
    SkipReturnSnatIpFlag no no Int64 Name of the original VPC OSS API (v2): DelNatgwService.bSkipReturnSnatip.
    Example: 1
    VpcId no no Int64 Integer VPCID.
    Example: 78257
    Protocol no no String Name of the original VPC OSS API (v2): DelNatgwService.proto
    Example: tcp
    ProtocolPort no no Int64 Name of the original VPC OSS API (v2): DelNatgwService.pport.
    Example: 554
    Bandwidth no no Int64 Name of the original VPC OSS API (v2): DelNatgwService.bandwidth.
    Example: 0
    VirtualGatewayType no no Int64 Name of the original VPC OSS API (v2): DelNatgwService.vgwType.
    Example: 0
    Vip no no String Name of the original VPC OSS API (v2): DelNatgwService.vip.
    Example: 9.241.203.205
    VirtualPort no no Int64 Name of the original VPC OSS API (v2): DelNatgwService.vport.
    Example: 13803
    VipBusiness no no String Name of the original VPC OSS API (v2): DelNatgwService.vipBusiness.
    Example: vipbus
    CreateTime no no String Name of the original VPC OSS API (v2): DelNatgwService.createTime.
    Example: 2021-12-27 18:09:40
    PoolId no no Int64 Name of the original VPC OSS API (v2): DelNatgwService.poolId.
    Example: 33362

    AddressTemplateItem

    Address Information

    Referenced by the following interfaces: CreateAddressTemplateGroup, DescribeAddressTemplateGroups

    name required NULL allowed type description
    AddressTemplateName no no String Address Template Name
    Example: demo
    AddressTemplateId yes no String Address template ID
    Example: ipm-ig8xpno8

    HaVip

    Description of HAVIP Information

    Referenced by the following interfaces: CreateHaVip, DescribeHaVips

    name required NULL allowed type description
    Vip yes no String Virtual IP address.
    Example: 10.0.0.10
    VpcId yes no String VPC ID of HAVIP.
    Example: vpc-hj3he929
    Visible no no Bool Whether the HAVIP is visible to the tenant.
    Example: True
    CdcId no no String CDC instance ID.
    Example: cluster-gbo27yc4
    HaVipId yes no String ID of HAVIP, which is the unique identifier of HAVIP.
    Example: havip-nswq8wkq
    CreatedTime yes no Datetime Creation time.
    Example: 2018-10-10 17:03:09
    TagSet no no Array of Tag Tag key-value pairs.
    Example:View
    HaVipName yes no String HAVIP name.
    Example: demo
    SubnetId yes no String Subnet ID of HAVIP.
    Example: subnet-4t7fr3fi
    NetworkInterfaceId yes no String Associated ENI ID of HAVIP.
    Example: eni-pnpcflil
    InstanceId yes no String Bound instance ID.
    Example: ins-kngiybxl
    State yes no String Status:
  • AVAILABLE: Running
  • UNBIND: Not bound.

    • Example: AVAILABLE
    HaVipAssociationSet no no Array of HaVipAssociation HAVIP switch scope.
    Example:View
    CheckAssociate no no Bool Whether HAVIP switch scope verification is enabled.
    Example: True
    AddressIp yes no String Bound EIP.
    Example: 100.10.123.131
    Business yes no String Business identifier using havip.
    Example: SCF
    FlushedTime no no String HAVIP refresh time. This parameter is used only as an output parameter. The refresh of FlushTime will be triggered by the following scenarios: (1) The instance sends a gratuitous ARP to trigger HAVIP drift. (2) Manually unbind the HAVIP from the ENI. The default value is 0000-00-00 00:00:00 when there is no update.
    Example: 2024-06-06 22:24:45
    Ipv6Vip no no String Virtual IPv6 address.
    Example: 240d:c000:f030:900:0:9d0b:92a5:af00
    IfnName no no String ENI interface name.
    Example: veth_21CF51f0
    IsCdc no no Uint64 Whether it is a CDC type HAVIP.
    Example:

    NetDetect

    Network probe object.

    Referenced by the following interfaces: CreateNetDetect, DescribeNetDetects

    name required NULL allowed type description
    VpcId yes no String The VPC instance ID, such as vpc-demoag78.
    Example: vpc-67wlqf6v
    VpcName yes no String VPC instance name.
    Example: demo
    SubnetId yes no String The subnet instance ID, such as subnet-demoag78.
    Example: subnet-8qywqc4y
    SubnetName yes no String Subnet instance name.
    Example: demo
    NetDetectId yes no String The network detection instance ID, such as netd-demoag78.
    Example: netd-7s4wt576
    NetDetectName yes no String Network probe name, up to 60 bytes in length.
    Example: demo
    DetectDestinationIp yes no Array of String Probe destination IPv4 address array. The maximum number is two.
    Example: ['1.1.1.3', '1.1.1.8']
    DetectSourceIp yes no Array of String IPv4 array of probe sources automatically allocated by the system. The length is 2.
    Example: ['1.1.1.3', '1.1.1.8']
    NextHopType yes no String Next hop type, currently supporting:
    VPN: VPN gateway;
    DIRECTCONNECT: Direct Connect gateway;
    PEERCONNECTION: Peer connection;
    NAT: NAT gateway;
    NORMAL_CVM: Normal CVM.
    Example: CVM
    NextHopDestination yes no String The next hop target gateway, with valid values depending on the next hop type:
    When the next hop type is VPN, the value should be the VPN gateway ID, such as vpngw-demoag78.
    When the next hop type is DIRECTCONNECT, the value should be the Direct Connect gateway ID, such as dcg-demoag78.
    When the next hop type is PEERCONNECTION, the value should be the peering connection ID, such as pcx-demoag78.
    When the next hop type is NAT, the value should be the NAT gateway, such as nat-demoag78.
    When the next hop type is NORMAL_CVM, the value should be the CVM IPv4 address, such as 10.0.0.12.
    Example: 10.0.0.198
    NextHopName yes yes String Next hop gateway name.
    Example: demo
    NetDetectDescription yes yes String Network probe description.
    Example: demo
    CreateTime yes yes Datetime Creation time.
    Example: 2018-06-21 11:32:29
    Status no no String NFV network detection status.
    Example: RUNNING

    DfwOssUSGOperateResult

    Complex type: DfwOssUSGOperateResult.

    Referenced by the following interfaces: CreateUSGRuleInternal, DeleteUSGInternal, DeleteUSGRuleInternal

    name required NULL allowed type description
    UsgId no no String Name of the original DFW API (v2): insertUSGRule.usgId.
    Example: sg-dn7qcw21
    ErrorCode no no Int64 Name of the original DFW API (v2): insertUSGRule.errorCode.
    Example: 0
    ErrorInfo no no String Name of the original DFW API (v2): insertUSGRule.errorInfo.
    Example: success

    Service

    Service Information

    Referenced by the following interfaces: DescribeServiceInternal

    name required NULL allowed type description
    VpcId no no String vpc id
    Example: vpc-m0c2kcun
    RouteSet no no Array of ServiceRoute Routing information set.
    Example:View
    GroupId no no Array of Uint64 Group ID
    Example: 5
    SetId no no Uint64 Set id
    Example: 0
    StickyTimeout no no Uint64 Session persistence timeout duration.
    Example: 0
    VipSetId no no Uint64 VIP set ID.
    Example: 1
    VpcGatewayIp no no String The vpcgwip accessed via Direct Connect.
    Example: 10.112.98.185
    VirtualPort no no Uint64 Vport port number.
    Example: 23
    HealthFlag no no Uint64 Health identifier.
    Example: 0
    SubnetRouteAlgorithm no no Uint64 Hash algorithm.
    Example: 0
    BypassFlag no no Uint64 Bypass identifier.
    Example: 0
    ResetFlag no no Uint64 RST message identifier.
    Example: 0
    Type no no Uint64 Type
    Example: 1
    Protocol no no String Protocol
    Example: udp
    IpType no no Uint64 IP Type
    Example: 29
    ClassicVpcGatewayId no no String The vpcgw cluster that accesses the VIP via ClassicLink.
    Example: vpcgw-7hk7255d
    VpcNumId no no Int64 The numeric ID of the VPC.
    Example: 122211
    VpcGatewayAttrFlag no no Uint64 When the vpcgw cluster type is 3 (vpcgw logical cluster selected based on the RS availability zone), the marker indicates whether forwarding is based on the VPCID + vip granularity of the cluster ID attribute.
    Example: 0
    SnatFlag no no Uint64 SNAT identifier.
    Example: 0
    StickyMaxCount no no Uint64 Maximum value for session persistence entries.
    Example: 1
    RemoteVpcId no no Uint64 Remote VPC ID.
    Example: 0
    VpcGatewayId no no String The vpcgw cluster ID accessed via CVM.
    Example: vpcgw-7hk7255d
    Business no no String Business type identifier.
    Example: dockerMaster
    VpcGatewayZoneId no no Uint64 When the vpcgw cluster type is 3 (vpcgw logical cluster selected based on the RS availability zone), it is used to return the availability zone of the RS.
    Example: 0
    FakeToaIp no yes String fakeToaIp is used to populate a fake client IP.
    Example: 192.168.0.1
    ToaHostIpFlag no no Uint64 Whether the TOA includes the client’s host IP identifier.
    Example: 0
    LbType no no Uint64 Whether it is an LB rule.
    Example: 0
    VipVpcGatewayId no no String Switch vpcGwIp. Select the vpcgwid corresponding to the vpcGwIp in the zone of the subnet where the VIP is located, choosing the nearest option.
    Example: vpcgw-7hk7255d
    Vip no no String VIP information
    Example: 172.16.48.216
    StickyFlag no no Uint64 Session persistence identifier.
    Example: 0
    RsZoneVpcGatewayId no no Uint64 When the vpcgw cluster type is 3 (vpcgw logical cluster selected based on the RS availability zone), the marker indicates whether the cluster ID is forwarded based on the vpcid + vip granularity. If bVpcgwAttrFlag=1, the cluster ID is returned; otherwise, 0 is returned, indicating that forwarding based on the cluster ID is disabled.
    Example: 0
    DelPipRouteFlag no no Int64 Original VPC OSS APIv2 name: AddService.bDelPipRoute.
    Example: 0

    SecurityGroupPolicySet

    Security Group Rule Collection

    Referenced by the following interfaces: CreateSecurityGroupPolicies, CreateSecurityGroupWithPolicies, DeleteSecurityGroupPolicies, DescribeSecurityGroupPolicies, ModifySecurityGroupPolicies, ReplaceSecurityGroupPolicy

    name required NULL allowed type description
    Version no no String Current version of the security group rules. Every time a user updates the security rules, the version will automatically increase by 1 to prevent the updated route rules from being outdated. If not specified, conflicts will not be considered.
    Example: 0
    Egress no no Array of SecurityGroupPolicy Outbound rules.
    Example:View
    Ingress no no Array of SecurityGroupPolicy Inbound rules.
    Example:View

    SslVpnClientConfig

    ssl-vpn-client-client-config Configuration

    Referenced by the following interfaces: DownloadVpnGatewaySSLClientCert

    name required NULL allowed type description
    SSLVpnClientConfiguration yes yes String Configure on client
    Example: client,dev tun,proto udp,remote...
    SSLVpnRootCert yes yes String Root certificate
    Example: BEGIN CERTIFICATE...
    SSLVpnKey yes yes String Client Key
    Example: BEGIN PRIVATE KEY...
    SSLVpnCert yes yes String Client certificate
    Example: BEGIN CERTIFICATE...

    CcnLimit

    CCN Quota

    Referenced by the following interfaces: DescribeCcnLimits

    name required NULL allowed type description
    Type yes no String CCN Quota Type
    Example: 1
    Value yes no Uint64 CCN Quota Value
    Example: 10

    CcnRegionBandwidthLimit

    CCN Regional Outbound Bandwidth Limit

    Referenced by the following interfaces: DescribeCcnRegionBandwidthLimits, GetCcnRegionBandwidthLimits, SetCcnRegionBandwidthLimits

    name required NULL allowed type description
    Region yes no String Region. For example, ap-region.
    Example: region
    BandwidthLimit yes no Uint64 Outbound bandwidth cap, in Mbps.
    Example: 10
    IsBm no no Bool Whether it is a Blackstone region. Default: False.
    Example: true
    DstRegion no yes String Destination region. For example, ap-region.
    Example: ap-region
    DstIsBm no no Bool Whether the destination region is a BM region, false by default.
    Example: true

    Address

    Describe EIP Information

    Referenced by the following interfaces: DescribeAddresses, DescribeIp6Addresses

    name required NULL allowed type description
    AddressId no yes String ID of EIP, which is the unique identifier of EIP.
    Example: eip-ip9ongec
    AddressName no yes String EIP name.
    Example: demoName
    AddressStatus no yes String EIP status. 'CREATING': creating; 'BINDING': binding; 'BIND': bound; 'UNBINDING': unbinding; 'UNBIND': unbound; 'OFFLINING': releasing; 'BIND_ENI': bound to idle ENIs; 'PRIVATE': IPv6 address with public network access disabled.
    Example: UNBIND
    AddressIp no yes String Public Network IP Address
    Example: 100.10.1.1
    InstanceId no yes String ID of the bound resource instance, which may be a CVM, NAT, or BMS instance.
    Example: ins-qw23er13
    CreatedTime no yes Datetime_iso Creation time. It is expressed by a UTC time according to the ISO8601 standard. The format is YYYY-MM-DDThh:mm:ssZ.
    Example: 2021-05-19T08:37:53Z
    NetworkInterfaceId no yes String Bound ENI ID
    Example: eni-37xao8t
    PrivateAddressIp no yes String Private IP of Resource Bound
    Example: 10.2.3.4
    IsArrears no yes Bool Resource isolation status. TRUE indicates that the EIP is isolated. FALSE indicates that the EIP is not isolated.
    Example: false
    IsBlocked no yes Bool Resource blocking status. TRUE indicates that the EIP is blocked. FALSE indicates that the EIP is not blocked.
    Example: false
    IsEipDirectConnection no yes Bool Whether EIP supports the Direct Connect mode. TRUE indicates Yes, and FALSE indicates No.
    Example: false
    AddressType no yes String EIP resource types, including "CalcIP", "WanIP", "EIP", and "AnycastEIP". Where, "CalcIP" indicates device IP; "WanIP" indicates general public network IP; "EIP" indicates elastic public IP; and "AnycastEip" indicates accelerated EIP.
    Example: EIP
    CascadeRelease no yes Bool Whether the EIP is automatically released after unbinding. True indicates that the EIP will be automatically released after unbinding. False indicates that the EIP will not be automatically released after unbinding.
    Example: false
    EipAlgType no yes AlgType EIP ALG enabled protocol type.
    Example:View
    InternetServiceProvider no yes String EIP ISP information. The current possible returned values include CMCC, CTCC, CUCC, and BGP.
    Example: BGP
    TagSet no yes Array of Tag List of Tags Bound to EIP
    Example:View
    ComplianceStatus no yes String EIP compliance status: BANNING and FREEZING. Others indicate normal.
    Example: BANNING
    ApplicableForCLB no yes Bool Whether it is used for CLB.
    Example: True
    IsNewGeneration no yes Bool Whether it is the next generation EIP.
    Example: True
    IsActiveAccessEip no yes Bool Whether to initiate active outbound connections.
    Example: True
    NetworkGroup no yes String EIP region information.
    Example: ap-region
    PayMode no yes String Billing method.
    Example: BANDWIDTH_POSTPAID_BY_MONTH
    DeadlineDate no yes Date Expiration time.
    Example: 2024-10-17 22:45:47
    IsEip no yes Bool Whether it is EIP.
    Example: True
    Bandwidth no yes Uint64 Bandwidth value of EIP. Note: EIPs of traditional accounts do not have a bandwidth attribute, so the value is empty.
    Example: 1
    UpdatedTime no yes String Update time.
    Example: 2024-10-17 22:45:47
    InternetChargeType no yes String Network billing mode of the EIP. Note: EIPs under traditional account types do not have a billing mode attribute, and its value is empty.
    Example: TRAFFIC_POSTPAID_BY_HOUR
    BindResourceType no yes String Bound resource type.
    Example: BIND_LB
    LocalBgp no yes Bool Whether it is a local bandwidth EIP.
    Example: false
    IsFromWanIP no yes Bool Whether to convert from WANIP.
    Example: true
    UnVpcId no yes String VPC ID.
    Example: vpc-ig8xpno8
    DedicatedClusterId no yes String Unique CDC ID.
    Example: cluster-gbo27yc4
    OnlyActiveAccess no yes Bool Whether to allow only active outbound access.
    Example: true

    SecurityGroupPolicy

    Security Group Rule Object

    Referenced by the following interfaces: CreateSecurityGroupPolicies, CreateSecurityGroupWithPolicies, DeleteSecurityGroupPolicies, DescribeSecurityGroupPolicies, DescribeSecurityGroupPolicyTemplates, ModifySecurityGroupPolicies, ReplaceSecurityGroupPolicy

    name required NULL allowed type description
    PolicyIndex no no Int64 Index number of security group rule.
    Example: 0
    Protocol no no String Protocol, value: TCP, UDP, and ICMP.
    Example: TCP
    Port no no String Port (all, discrete, and range).
    Example: 22
    ServiceTemplate no no ServiceTemplateSpecification Protocol port ID or protocol port group ID. ServiceTemplate and Protocol+Port are mutually exclusive.
    Example:View
    CidrBlock no no String IP Range or IP (mutually exclusive).
    Example: 0.0.0.0/16
    Ipv6CidrBlock no no String IP Range or IPv6 (mutually exclusive).
    Example: ::/0
    SecurityGroupId no no String Security group instance ID, e.g., sg-ohuuioma.
    Example: sg-ohuuioma
    AddressTemplate no no AddressTemplateSpecification IP address ID or IP Address Group ID.
    Example:View
    Action no no String ACCEPT or DROP.
    Example: ACCEPT
    PolicyDescription no no String Security group rule description.
    Example: Desc
    ModifyTime no no String Last modified time of security group.
    Example: 2021-03-02 14:41:15

    OldRouteSet

    Legacy Route Collection

    Referenced by the following interfaces: ReplaceRoutes

    name required NULL allowed type description
    RouteId no no String Route ID
    Example: 16820
    DestinationCidrBlock no no String Target IP Range
    Example: 169.254.128.0/17
    GatewayType no no String Gateway type
    Example: NORMAL_CVM
    GatewayId no no String Gateway ID
    Example: 172.16.16.37
    RouteDescription no no String Route Description
    Example: demo

    Ipv6SectionSet

    IPv6 address pool object.

    Referenced by the following interfaces: DescribeIpv6Section

    name required NULL allowed type description
    SectionId no no Uint64 Unique ID of an IPv6 address pool.
    Example: 31
    CidrBlock no no String IPv6 address pool IP range.
    Example: 3402:4e00:20:1200::/56
    AddressType no no Uint64 IPv6 address type.
    Example: 0/1
    EnableSplit no no Uint64 Whether to support automatic splitting.
    Example: 0: not supported; 1: customization supported.

    VpcOssEniForDescribeEniInternal

    Complex type: VpcOssEniForDescribeEniInternal.

    Referenced by the following interfaces: DescribeEniInternal

    name required NULL allowed type description
    Business no no String Name of the original VPC OSS API (v2): GetEni.business.
    Example: xxx
    Owner no no String User app ID
    Example: 251198225
    SubnetId no no Int64 Integer subnetId.
    Example: 1990867
    ArpLearningFlag no no Int64 Name of the original VPC OSS API (v2): GetEni.bArpLearning.
    Example: 1
    EniId no no Int64 Name of the original VPC OSS API (v2): GetEni.eniId.
    Example: 2660066
    UniqueEniId no no String Name of the original VPC OSS API (v2): GetEni.uniqEniId.
    Example: eni-kj7karc5
    UniqueVpcId no no String The externally unique VPCID.
    Example: vpc-jmaywf6r
    UniqueSubnetId no no String The externally unique SubnetId.
    Example: subnet-dbrazzr0
    ElasticNetworkCardName no no String Name of the original VPC OSS API (v2): GetEni.ifnName.
    Example: veni_vFspLEfU
    Type no no Int64 Name of the original VPC OSS API (v2): GetEni.type.
    Example: 0
    CreateTime no no String Name of the original VPC OSS API (v2): GetEni.createTime.
    Example: 2021-07-06 09:52:34
    State no no Int64 Name of the original VPC OSS API (v2): GetEni.state.
    Example: 1
    Name no no String Name
    Example: TEST
    VpcId no no Int64 Integer VPCID.
    Example: 78257
    Description no no String Name of the original VPC OSS API (v2): GetEni.description.
    Example: xxx
    BusinessOwner no no String Name of the original VPC OSS API (v2): GetEni.businessOwner.
    Example: xxx
    Mac no no String Name of the original VPC OSS API (v2): GetEni.mac.
    Example: 20:90:6F:BF:08:D2

    DfwOssUSGQuotaResult

    Complex type: DfwOssUSGQuotaResult.

    Referenced by the following interfaces: DescribeUSGQuotaInternal

    name required NULL allowed type description
    SgId no no String Name of the original DFW API (v2): getUSGQuota.sgId.
    Example: 251197522
    Quota no no DfwOssUSGQuota Name of the original DFW API (v2): getUSGQuota.quota.
    Example:View

    NatGatewayAddress

    Elastic IP Bound to NAT Gateway

    Referenced by the following interfaces: CreateNatGateway, DescribeNatGateways

    name required NULL allowed type description
    AddressId no no String The unique ID of the EIP, such as eip-jrkzpvgt.
    Example: eip-jrkzpvgt
    PublicIpAddress no no String Public IP address, e.g., 123.121.34.33.
    Example: 123.121.34.3
    IsBlocked no no Bool Resource blocking status. TRUE indicates that the EIP is blocked. FALSE indicates that the EIP is not blocked.
    Example: true

    VpcOssIp

    Complex type: VpcOssIp.

    Referenced by the following interfaces: DescribeIpInternal

    name required NULL allowed type description
    DirtyFlag no no Int64 Name of the original VPC OSS API (v2): GetIp.bDirty.
    Example: 0
    UniqueVpcId no no String The externally unique VPCID.
    Example: vpc-jmaywf6r
    Ip no no String Name of the original VPC OSS API (v2): GetIp.ip.
    Example: 169.254.128.2
    Mask no no String Mask
    Example: 255.255.128.0
    UniqueInstanceId no no String Name of the original VPC OSS API (v2): GetIp.uniqInstanceId.
    Example: instance-asdaq1
    IpType no no Int64 Name of the original VPC OSS API (v2): GetIp.ipType.
    Example: 0
    CreateTime no no String Name of the original VPC OSS API (v2): GetIp.createTime.
    Example: 2021-03-22 21:35:59
    Subnet no no String Subnet address
    Example: 169.254.128.0
    VpcId no no Int64 Integer VPCID.
    Example: 78257
    IntSubnet no no Int64 Name of the original VPC OSS API (v2): GetIp.intSubnet.
    Example: 2852028416
    Gateway no no String Name of the original VPC OSS API (v2): GetIp.gateway.
    Example: 169.254.128.1
    Flag no no Int64 Name of the original VPC OSS API (v2): GetIp.flag.
    Example: 0

    DfwOssInsertUSGRuleRequest

    Complex type: DfwOssInsertUSGRuleRequest.

    Referenced by the following interfaces: CreateUSGRuleInternal

    name required NULL allowed type description
    UsgId no no String Name of the original DFW API (v2): insertUSGRule.usgId.
    Example: 123123
    Index no no Int64 Name of the original DFW API (v2): insertUSGRule.index.
    Example: 1
    Direction no no String Name of the original DFW API (v2): insertUSGRule.direction.
    Example: inbound
    Version no no Int64 Name of the original DFW API (v2): insertUSGRule.version.
    Example: 12
    Policies no no Array of DfwOssUSGPolicyItem Name of the original DFW API (v2): insertUSGRule.policies.
    Example:View