Failed instance info
Used by actions: TerminateInstances.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID. |
| ErrorCode | String | Error code. |
| ErrorMessage | String | Error message. |
Describe physical machine instance information
Used by actions: DescribeInstances.
| Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID. |
| InstanceName | String | Instance name. |
| MachineId | String | Bound Physical Machine ID |
| InstanceType | String | Model specifications |
| Zone | String | Availability zone code |
| ImageId | String | Image ID. |
| InstanceStatus | String | Instance status, value range: allocating, running, isolating, isolated, terminating, error. |
| OperateStatus | String | Operation status: normal, starting, stopping, stopped, rebooting. |
| PrivateNetworkId | String | VPC ID. |
| PrivateIp | String | Private IPv4 address |
| PrivateIpV6 | String | Private IPv6 address |
| PublicNetworkId | String | Public network ID. |
| PublicIp | String | Public IPv4 address |
| PublicIpV6 | String | Public IPv6 address |
| FileSystemType | String | File System Type |
| CreatedTime | Timestamp ISO8601 | Creation time, in the ISO 8601 standard format, using UTC time. Format: YYYY-MM-DDThh:mm:ssZ. |
| InstanceFamily | String | Instance family flag |
| InstanceFamilyName | String | Model Family Name |
| CpuType | String | CPU Model |
| Cpu | Integer | CPU cores. |
| Memory | Integer | Memory size. |
Account model quota information in the availability zone, including availability zone, model detail and quota quantity.
Used by actions: DescribeInstanceTypes.
| Name | Type | Description |
|---|---|---|
| Zone | String | Availability zone code. |
| InstanceType | String | Model specifications. |
| InstanceFamily | String | Model family. |
| InstanceFamilyName | String | Model family name |
| CpuCores | Integer | Number of CPU cores. |
| CpuType | String | CPU type. |
| MemoryGb | Integer | Memory size (GB). |
| SystemDiskType | String | System disk type. |
| SystemDiskSize | Integer | System disk size (GB). |
| SystemDiskCount | Integer | Number of system disks. |
| DataDiskType | String | Data disk type. |
| DataDiskSize | Integer | Data disk size (GB). |
| DataDiskCount | Integer | Number of data disks. |
| SecondaryDataDiskType | String | Second set of data disk types |
| SecondaryDataDiskSize | Integer | Data disk size of the second group (GB) |
| SecondaryDataDiskCount | Integer | Number of data disks in the second set |
| DiskType | String | Disk description string (backward compatibility). |
| NetworkInterfaceType | String | Network interface type. |
| GpuType | String | GPU type. Empty string if no GPU is available. |
| Quota | Integer | Quota quantity |
Public Ip information
Used by actions: DescribePublicIps.
| Name | Type | Required | Description |
|---|---|---|---|
| Ip | String | No | 10.100.0.20 |
| NetworkInstanceId | String | No | epn-asdfghjkl |
| InstanceId | String | No | epm-asdfghjkl |
| State | String | No | Unbound |
| Type | String | No | Ipv4 |
| CreatedAt | String | No | 2026-04-07T00:00:00 |
| UpdatedAt | String | No | 2026-04-07T00:00:00 |
Private network instance information
Used by actions: DescribePrivateNetworkInstances.
| Name | Type | Description |
|---|---|---|
| NetworkInstanceId | String | Private network instance ID |
| NetworkInstanceName | String | Private network instance name |
| ZoneId | String | Availability zone ID. |
| Network | String | Network address. |
| Mask | Integer | Network mask |
| ServerCount | Integer | Number of associated physical machines |
| AvailableIpCount | Integer | Available Ip quantity |
| CreatedAt | String | Creation time. |
| UpdatedAt | String | Update time |
Public network instance info, including instance ID, availability zone ID, instance name, line, routing mode, etc.
Used by actions: DescribePublicNetworkInstances.
| Name | Type | Description |
|---|---|---|
| NetworkInstanceId | String | Public network instance ID |
| ZoneId | String | Availability zone ID. |
| NetworkInstanceName | String | Public network instance name Note: This field may return null, indicating that no valid values can be obtained. |
| Bandwidth | Integer | Bandwidth, Unit: Mbps Note: This field may return null, indicating that no valid values can be obtained. |
| Line | String | Line information |
| RouteMode | String | Routing mode, enumeration value: STATIC, BGP, OSPF |
| ServerCount | Integer | Number of Associated Physical Servers |
| Ipv4Count | Integer | Applied Ipv4 quantity |
| Ipv6Count | Integer | Number of applied Ipv6 addresses |
| Ipv4CidrSet | Array of PublicNetworkSegment | Associated Ipv4 subnet Note: This field may return null, indicating that no valid values can be obtained. |
| Ipv6CidrSet | Array of PublicNetworkSegment | Associated Ipv6 segment Note: This field may return null, indicating that no valid values can be obtained. |
| CreatedAt | String | Public network instance creation time |
| UpdatedAt | String | Public network instance last modified |
Public network ip range info, including cidr and gateway ip
Used by actions: DescribePublicNetworkInstances.
| Name | Type | Description |
|---|---|---|
| Cidr | String | Cidr of the subnet |
| Gateway | String | Gateway Ip |
Switch data
Used by actions: DescribeZoneData.
| Name | Type | Description |
|---|---|---|
| Time | String | UTC time |
| Value | Float | Statistical value |
Cross-regional AZ information after aggregating.
Used by actions: DescribeZones.
| Name | Type | Description |
|---|---|---|
| ZoneId | Integer | AZ ID. |
| Zone | String | Availability zone code. |
| ZoneName | String | Chinese Name of Availability Zone. |
| ZoneNameEn | String | Availability zone English name. |
| Region | String | Region code. |
| Location | String | Area code. |
| LocationName | String | Region name. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback