Data Types

Last updated: 2021-04-28 17:51:44

AccountAttribute

Account attribute object

Used by actions: DescribeAccountAttributes.

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

Address

Detailed EIP information

Used by actions: DescribeAddresses.

Name Type Description
AddressId String EIP ID, the unique ID of the EIP.
AddressName String The EIP name.
AddressStatus String Possible EIP states are 'CREATING', 'BINDING', 'BIND', 'UNBINDING', 'UNBIND', 'OFFLINING', and 'BIND_ENI'.
AddressIp String The public IP address
InstanceId String The ID of the bound resource instance. This can be a CVM or NAT.
CreatedTime Timestamp ISO8601 The creation time, which follows the ISO8601 standard and uses UTC time in the format of YYYY-MM-DDThh:mm:ssZ.
NetworkInterfaceId String The ID of the bound ENI
PrivateAddressIp String The private IP of the bound resources
IsArrears Boolean The isolation status of the resource. True indicates the EIP is isolated. False indicates that the resource is not isolated.
IsBlocked Boolean The block status of the resource. True indicates the EIP is blocked. False indicates that the EIP is not blocked.
IsEipDirectConnection Boolean Whether the EIP supports direct connection mode. True indicates the EIP supports direct connection. False indicates that the resource does not support direct connection.
AddressType String The resource type of the EIP. This includes CalcIP, WanIP, EIP, and AnycastEIP. Among these, CalcIP indicates the device IP, WanIP indicates the common public IP, EIP indicates Elastic IP, and AnycastEip indicates accelerated EIP.
CascadeRelease Boolean Whether the EIP is automatically released after being unbound. True indicates the EIP will be automatically released after being unbound. False indicates the EIP will not be automatically released after being unbound.
EipAlgType AlgType Type of the protocol used in EIP ALG
InternetServiceProvider String The ISP of an EIP/Elastic IP, with possible return values currently including "CMCC", "CTCC", "CUCC" and "BGP"
LocalBgp Boolean Whether the EIP is in a local BGP.
Bandwidth Integer Bandwidth value of EIP. The EIP for the bill-by-CVM account will return null.
Note: this field may return null, indicating that no valid value was found.
InternetChargeType String Network billing mode of EIP. The EIP for the bill-by-CVM account will return null.
Note: this field may return null, indicating that no valid value was found.

AddressChargePrepaid

EIP cost object

Used by actions: AllocateAddresses, ModifyAddressInternetChargeType.

Name Type Required Description
Period Integer Yes Purchased usage period, in month. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36
AutoRenewFlag Integer No Setting of renewal. Valid values: 0: manual renewal; 1: auto-renewal; 2: no renewal after expiration. Default value: 0

AddressTemplate

IP address template

Used by actions: CreateAddressTemplate, DescribeAddressTemplates.

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

AddressTemplateGroup

IP address template group

Used by actions: CreateAddressTemplateGroup, DescribeAddressTemplateGroups.

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

AddressTemplateItem

Address information

Used by actions: CreateAddressTemplateGroup, DescribeAddressTemplateGroups.

Name Type Required Description
From String Yes Start address
To String Yes End address

AddressTemplateSpecification

IP address template.

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

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

AlgType

ALG protocol type

Used by actions: DescribeAddresses.

Name Type Description
Ftp Boolean Whether FTP ALG is enabled
Sip Boolean Whether SIP ALG is enabled

AssistantCidr

Information about the secondary CIDR of the VPC.

Used by actions: CreateAssistantCidr, CreateVpc, DescribeAssistantCidr, DescribeVpcs, ModifyAssistantCidr.

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

BandwidthPackage

The structure of information of the bandwidth package.

Used by actions: DescribeBandwidthPackages.

Name Type Description
BandwidthPackageId String The unique ID of the bandwidth package.