Attachment information
Used by actions: DescribeInstancesDiskNum.
Name | Type | Description |
---|---|---|
InstanceId | String | Instance ID |
AttachedDiskCount | Integer | Number of elastic cloud disks attached to the instance |
MaxAttachCount | Integer | Upper limit of attached elastic cloud disks |
Automatically attach and initialize the data disk.
Used by actions: CreateDisks.
Name | Type | Required | Description |
---|---|---|---|
InstanceId | String | Yes | ID of the instance to be mounted to. The instance must be Running. |
MountPoint | String | No | The mount point within the instance. Only Linux instances are supported. If it's not specified, the default mount point is "/data/disk". |
FileSystemType | String | No | The file system type. Values: ext4 (default) and xfs . Only Linux instances are supported. |
Image information.
Used by actions: DescribeBlueprintInstances, DescribeBlueprints, DescribeResetInstanceBlueprints.
Name | Type | Description |
---|---|---|
BlueprintId | String | Image ID, which is the unique identifier of Blueprint . |
DisplayTitle | String | Image title to be displayed. |
DisplayVersion | String | Image version to be displayed. |
Description | String | Image description information. Note: This field may return null , indicating that no valid values can be obtained. |
OsName | String | OS name. |
Platform | String | OS type. |
PlatformType | String | OS type, such as LINUX_UNIX and WINDOWS. |
BlueprintType | String | Image type, such as APP_OS, PURE_OS, and PRIVATE. |
ImageUrl | String | Image picture URL. |
RequiredSystemDiskSize | Integer | System disk size required by image in GB. |
BlueprintState | String | Image status. |
CreatedTime | Timestamp ISO8601 | Creation time according to ISO 8601 standard. UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ. Note: this field may return null, indicating that no valid values can be obtained. |
BlueprintName | String | Image name. |
SupportAutomationTools | Boolean | Whether the image supports automation tools. |
RequiredMemorySize | Integer | Memory size required by image in GB. |
ImageId | String | ID of the Lighthouse image shared from a CVM image Note: this field may return null , indicating that no valid values can be obtained. |
CommunityUrl | String | URL of official website of the open-source project |
GuideUrl | String | Guide documentation URL |
SceneIdSet | Array of String | Array of IDs of scenes associated with an image Note: This field may return null , indicating that no valid values can be obtained. |
DockerVersion | String | Docker version. Note: This field may return null , indicating that no valid values can be obtained. |
Image instance information.
Used by actions: DescribeBlueprintInstances.
Name | Type | Description |
---|---|---|
Blueprint | Blueprint | Image information. |
SoftwareSet | Array of Software | Software list. |
InstanceId | String | Instance ID. |
BlueprintPrice Custom image price parameter.
Used by actions: InquirePriceCreateBlueprint.
Name | Type | Description |
---|---|---|
OriginalBlueprintPrice | Float | Original image unit price in USD. |
OriginalPrice | Float | Original image total price in USD. |
Discount | Integer | Discount. |
DiscountPrice | Float | Discounted image total price in USD. |
Package information.
Used by actions: DescribeBundles, DescribeModifyInstanceBundles.
Name | Type | Description |
---|---|---|
BundleId | String | Package ID. |
Memory | Integer | Memory size in GB. |
SystemDiskType | String | System disk type. Values: CLOUD_SSD : SSD cloud disksCLOUD_PREMIUM : Premium cloud disks |
SystemDiskSize | Integer | System disk size in GB. |
MonthlyTraffic | Integer | Monthly network traffic in GB. |
SupportLinuxUnixPlatform | Boolean | Whether Linux/Unix is supported. |
SupportWindowsPlatform | Boolean | Whether Windows is supported. |
Price | Price | Current package unit price information. |
CPU | Integer | Number of CPU cores. |
InternetMaxBandwidthOut | Integer | Peak bandwidth in Mbps. |
InternetChargeType | String | Network billing mode. |
BundleSalesState | String | Package sale status. Valid values: AVAILABLE, SOLD_OUT |
BundleType | String | Bundle type. Valid values: |
BundleTypeDescription | String | Bundle type description Note: This parameter may return null, indicating that no valid values can be obtained. |
BundleDisplayLabel | String | Package tag. Valid values: "ACTIVITY": promotional package "NORMAL": regular package "CAREFREE": carefree package |
List of instances associated with the CCN instance.
Used by actions: DescribeCcnAttachedInstances.
Name | Type | Description |
---|---|---|
CcnId | String | CCN instance ID. |
CidrBlock | Array of String | CIDR block of associated instance. |
State | String | Associated instance status: • PENDING: applying • ACTIVE: connected • EXPIRED: expired • REJECTED: rejected • DELETED: deleted • FAILED: failed (it will be asynchronously unassociated after 2 hours) • ATTACHING: associating • DETACHING: unassociating • DETACHFAILED: failed to unassociate (it will be asynchronously unassociated after 2 hours) |
AttachedTime | Timestamp | Association time. Note: this field may return null, indicating that no valid values can be obtained. |
Description | String | Remarks |
Container environment variable
Used by actions: CreateInstances.
Name | Type | Required | Description |
---|---|---|---|
Key | String | Yes | Environment variable key |
Value | String | Yes | Environment variable value |
Data disk price
Used by actions: InquirePriceRenewInstances.
Name | Type | Description |
---|---|---|
DiskId | String | Cloud disk ID. |
OriginalDiskPrice | Float | Cloud disk unit price. |
OriginalPrice | Float | Total price of cloud disk |
Discount | Float | Discount. |
DiscountPrice | Float | Discounted total price. |
InstanceId | String | ID of the instance to which the data disk is mounted. Note: This field may return null , indicating that no valid value was found. |
Restricted operation.
Used by actions: DescribeDisksDeniedActions, DescribeInstancesDeniedActions, DescribeSnapshotsDeniedActions.
Name | Type | Description |
---|---|---|
Action | String | Restricted operation name. |
Code | String | Restricted operation message code. |
Message | String | Restricted operation message. |
Billable items
Used by actions: InquirePriceCreateDisks, InquirePriceRenewDisks.
Name | Type | Description |
---|---|---|
PriceName | String | Values: |
OriginUnitPrice | Float | Official unit price of the billable item |
OriginalPrice | Float | Official total price of the billable item |
Discount | Float | Discount of the billable item |
DiscountPrice | Float | Discounted total price of the billable item |
Package discount details (only returned for price query APIs called in the console).
Used by actions: DescribeBundleDiscount, DescribeDiskDiscount, InquirePriceRenewInstances.
Name | Type | Description |
---|---|---|
TimeSpan | Integer | Billing duration. |
TimeUnit | String | Billing unit. |
TotalCost | Float | Total price. |
RealTotalCost | Float | Discounted total price. |
Discount | Integer | Discount. |
PolicyDetail | PolicyDetail | Discount details. |
Disk information
Used by actions: DescribeDisks.
Name | Type | Description |
---|---|---|
DiskId | String | Disk ID |
InstanceId | String | Instance ID |
Zone | String | Availability zone |
DiskName | String | Disk name |
DiskUsage | String | Disk type |
DiskType | String | Disk media type |
DiskChargeType | String | Disk payment type |
DiskSize | Integer | Disk size |
RenewFlag | String | Renewal flag |
DiskState | String | Disk status. Values: PENDING : CreatingUNATTACHED : Not attachedATTACHING : AttachingATTACHED : AttachedDETACHING : DetachingSHUTDOWN : IsolatedCREATED_FAILED : Failed to createTERMINATING : TerminatingDELETING : DeletingFREEZING : Freezing |
Attached | Boolean | Whether the disk is attached to an instance |
DeleteWithInstance | Boolean | Whether to release the disk along with the instance |
LatestOperation | String | Last operation |
LatestOperationState | String | Last operation status |
LatestOperationRequestId | String | Last request ID |
CreatedTime | Timestamp ISO8601 | Creation time according to ISO 8601 standard. UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ. Note: This field may return null , indicating that no valid values can be obtained. |
ExpiredTime | Timestamp ISO8601 | Expiration time according to ISO 8601 standard. UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ. Note: This field may return null, indicating that no valid values can be obtained. |
IsolatedTime | Timestamp ISO8601 | Isolation time according to ISO 8601 standard. UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ. Note: This field may return null, indicating that no valid values can be obtained. |
DiskBackupCount | Integer | Total disk backups |
DiskBackupQuota | Integer | Disk backup quota |
Parameter settings for the monthly subscribed cloud disk
Used by actions: CreateDisks, InquirePriceCreateDisks.
Name | Type | Required | Description |
---|---|---|---|
Period | Integer | Yes | Purchase duration. |
RenewFlag | String | No | Auto-Renewal flag. Valid values:NOTIFY_AND_AUTO_RENEW : Trigger expiration notification and renew automaticallyNOTIFY_AND_MANUAL_RENEW : Trigger expiration notification but do not renewu200cDISABLE_NOTIFY_AND_AUTO_RENEW : Neither trigger expiration notification nor renewDefault: NOTIFY_AND_MANUAL_RENEW . If NOTIFY_AND_AUTO_RENEW is specified, the instance is automatically renewed on a monthly basis when the account balance is sufficient. |
TimeUnit | String | No | Purchase duration unit. Default value: "m" (month) |
Cloud disk configuration
Used by actions: DescribeDiskConfigs.
Name | Type | Description |
---|---|---|
Zone | String | Availability zone. |
DiskType | String | Cloud disk type. |
DiskSalesState | String | Cloud disk sale status. |
MaxDiskSize | Integer | Maximum cloud disk size. |
MinDiskSize | Integer | Minimum cloud disk size. |
DiskStepSize | Integer | Cloud disk increment. |
List of operation limits of disks.
Used by actions: DescribeDisksDeniedActions.
Name | Type | Description |
---|---|---|
DiskId | String | Cloud disk ID. |
DeniedActions | Array of DeniedAction | List of operation limits. |
Cloud disk price
Used by actions: InquirePriceCreateDisks, InquirePriceRenewDisks.
Name | Type | Description |
---|---|---|
OriginalDiskPrice | Float | Cloud disk unit price. |
OriginalPrice | Float | Total cloud disk price. |
Discount | Float | Discount. |
DiscountPrice | Float | Discounted total price. |
DetailPrices | Array of DetailPrice | Detailed billing items |
Details of the returnable cloud disk
Used by actions: DescribeDisksReturnable.
Name | Type | Description |
---|---|---|
DiskId | String | Cloud disk ID. |
IsReturnable | Boolean | Whether the cloud disk can be returned. |
ReturnFailCode | Integer | Error code of cloud disk return failure. |
ReturnFailMessage | String | Error message of cloud disk return failure. |
Configuration used to create Docker containers
Used by actions: CreateInstances.
Name | Type | Required | Description |
---|---|---|---|
ContainerImage | String | Yes | Container image address |
ContainerName | String | No | Container name |
Envs | Array of ContainerEnv | No | List of environment variables |
PublishPorts | Array of DockerContainerPublishPort | No | List of mappings of container ports and host ports |
Volumes | Array of DockerContainerVolume | No | List of container mount volumes |
Command | String | No | The command to run |
Port mapping of the Docker container
Used by actions: CreateInstances.
Name | Type | Required | Description |
---|---|---|---|
HostPort | Integer | Yes | Host port |
ContainerPort | Integer | Yes | Container port |
Ip | String | No | External IP. It defaults to 0.0.0.0. Note: This field may return null, indicating that no valid values can be obtained. |
Protocol | String | No | The protocol defaults to tcp . Valid values: tcp , udp and sctp .Note: This field may return null, indicating that no valid values can be obtained. |
Docker container mount volume
Used by actions: CreateInstances.
Name | Type | Required | Description |
---|---|---|---|
ContainerPath | String | Yes | Container path |
HostPath | String | No | Host path |
Key-Value pair filter for conditional filtering queries, such as filtering name
- If there are multiple
Filter
parameters, the relationship among them is the logicalAND
.- If there are multiple
Values
for the sameFilter
, the relationship among theValues
is the logicalOR
.Taking the
Filter
in theDescribeInstances
API as an example, you can use the following filters to query the instance whose name (instance-name
) istest
and private IP (private-ip-address
) is 10.10.10.10:
Filters.0.Name=instance-name
&Filters.0.Values.0=test
&Filters.1.Name=private-ip-address
&Filters.1.Values.0=10.10.10.10
Used by actions: DescribeBlueprints, DescribeBundles, DescribeDiskConfigs, DescribeDisks, DescribeInstances, DescribeKeyPairs, DescribeModifyInstanceBundles, DescribeResetInstanceBlueprints, DescribeSnapshots.
Name | Type | Required | Description |
---|---|---|---|
Name | String | Yes | Field to be filtered. |
Values | Array of String | Yes | Filter value of field. |
Firewall rule information.
Used by actions: CreateFirewallRules, DeleteFirewallRules, ModifyFirewallRuleDescription, ModifyFirewallRules.
Name | Type | Required | Description |
---|---|---|---|
Protocol | String | Yes | Protocol. Valid values: TCP, UDP, ICMP, ALL. |
Port | String | No | Port. Valid values: ALL, one single port, multiple ports separated by commas, or port range indicated by a minus sign |
CidrBlock | String | No | IP range or IP (mutually exclusive). Default value: 0.0.0.0/0, which indicates all sources. |
Action | String | No | Valid values: ACCEPT, DROP. Default value: ACCEPT. |
FirewallRuleDescription | String | No | Firewall rule description. |
Firewall rule details.
Used by actions: DescribeFirewallRules, DescribeFirewallRulesTemplate.
Name | Type | Description |
---|---|---|
AppType | String | Application type. Valid values: custom, HTTP (80), HTTPS (443), Linux login (22), Windows login (3389), MySQL (3306), SQL Server (1433), all TCP ports, all UDP ports, Ping-ICMP, ALL. |
Protocol | String | Protocol. Valid values: TCP, UDP, ICMP, ALL. |
Port | String | Port. Valid values: ALL, one single port, multiple ports separated by commas, or port range indicated by a minus sign |
CidrBlock | String | IP range or IP (mutually exclusive). Default value: 0.0.0.0/0, which indicates all sources. |
Action | String | Valid values: ACCEPT, DROP. Default value: ACCEPT. |
FirewallRuleDescription | String | Firewall rule description. |
General resource quota information.
Used by actions: DescribeGeneralResourceQuotas.
Name | Type | Description |
---|---|---|
ResourceName | String | Resource name. |
ResourceQuotaAvailable | Integer | Number of available resources. |
ResourceQuotaTotal | Integer | Total number of resources. |
Instance information.
Used by actions: DescribeInstances.
Name | Type | Description |
---|---|---|
InstanceId | String | Instance ID. |
BundleId | String | Package ID. |
BlueprintId | String | Image ID. |
CPU | Integer | Number of instance CPU cores. |
Memory | Integer | Instance memory capacity in GB. |
InstanceName | String | Instance name. |
InstanceChargeType | String | Instance billing mode. Valid values: PREPAID: prepaid (i.e., monthly subscription). |
SystemDisk | SystemDisk | Instance system disk information. |
PrivateAddresses | Array of String | Private IP of instance primary ENI. Note: this field may return null, indicating that no valid values can be obtained. |
PublicAddresses | Array of String | Public IP of instance primary ENI. Note: this field may return null, indicating that no valid values can be obtained. |
InternetAccessible | InternetAccessible | Instance bandwidth information. |
RenewFlag | String | Auto-Renewal flag. Valid values: NOTIFY_AND_MANUAL_RENEW: notify upon expiration but do not renew automatically NOTIFY_AND_AUTO_RENEW: notify upon expiration and renew automatically. |
LoginSettings | LoginSettings | Instance login settings. |
InstanceState | String | Instance status. Valid values: |
Uuid | String | Globally unique ID of instance. |
LatestOperation | String | Last instance operation, such as StopInstances and ResetInstance . Note: this field may return null, indicating that no valid values can be obtained. |
LatestOperationState | String | Last instance operation status. Valid values: SUCCESS: operation succeeded OPERATING: the operation is being executed FAILED: operation failed Note: this field may return null, indicating that no valid values can be obtained. |
LatestOperationRequestId | String | Unique request ID for the last operation of the instance. Note: this field may return null, indicating that no valid values can be obtained. |
IsolatedTime | Timestamp ISO8601 | Isolation time according to ISO 8601 standard. UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ. Note: this field may return null, indicating that no valid values can be obtained. |
CreatedTime | Timestamp ISO8601 | Creation time according to ISO 8601 standard. UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ. Note: this field may return null, indicating that no valid values can be obtained. |
ExpiredTime | Timestamp ISO8601 | Expiration time according to ISO 8601 standard. UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ. Note: this field may return null, indicating that no valid values can be obtained. |
PlatformType | String | OS type, such as LINUX_UNIX and WINDOWS. |
Platform | String | OS type. |
OsName | String | OS name. |
Zone | String | AZ. |
Tags | Array of Tag | The list of tags associated with the instance |
InstanceRestrictState | String | Obtain instance status |
Instance billing mode
Used by actions: CreateInstances, InquirePriceCreateInstances, InquirePriceRenewInstances, RenewInstances.
Name | Type | Required | Description |
---|---|---|---|
Period | Integer | Yes | Subscription period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, 60. |
RenewFlag | String | No | Auto-Renewal flag. Valid values: Default value: NOTIFY_AND_MANUAL_RENEW. If this parameter is specified as NOTIFY_AND_AUTO_RENEW , the instance will be automatically renewed monthly if the account balance is sufficient. |
List of instance operation limits.
Used by actions: DescribeInstancesDeniedActions.
Name | Type | Description |
---|---|---|
InstanceId | String | Instance ID. Note: this field may return null, indicating that no valid values can be obtained. |
DeniedActions | Array of DeniedAction | List of operation limits. |
Price information of Lighthouse instances
Used by actions: InquirePriceCreateInstances, InquirePriceRenewInstances.
Name | Type | Description |
---|---|---|
OriginalBundlePrice | Float | Original package unit price. |
OriginalPrice | Float | Original price. |
Discount | Integer | Discount. |
DiscountPrice | Float | Discounted price. |
Currency | String | Currency unit. Valid values: CNY and USD .Note: This field may return null , indicating that no valid values can be obtained. |
Instance price details
Used by actions: InquirePriceRenewInstances.
Name | Type | Description |
---|---|---|
InstanceId | String | Instance ID. Note: This field may return null , indicating that no valid value was found. |
InstancePrice | InstancePrice | Price query information. Note: This field may return null , indicating that no valid value was found. |
DiscountDetail | Array of DiscountDetail | Tiered-pricing details. The information of each tier includes the billable period, discount percentage, total price, discounted price, and discount details (UserDiscount , CommonDiscount and FinalDiscount ).Note: This field may return null , indicating that no valid values can be obtained. |
Whether the instance can be returned.
Used by actions: DescribeInstancesReturnable.
Name | Type | Description |
---|---|---|
InstanceId | String | Instance ID. |
IsReturnable | Boolean | Whether the instance can be returned. |
ReturnFailCode | Integer | Error code of instance return failure. |
ReturnFailMessage | String | Error message of instance return failure. |
Instance traffic package details
Used by actions: DescribeInstancesTrafficPackages.
Name | Type | Description |
---|---|---|
InstanceId | String | Instance ID. |
TrafficPackageSet | Array of TrafficPackage | List of traffic package details. |
This describes the internet accessibility of the instance created by a launch configuration and declares the internet usage billing method of the instance and the maximum bandwidth
Used by actions: DescribeInstances.
Name | Type | Description |
---|---|---|
InternetChargeType | String | Network billing mode. Valid values: |
InternetMaxBandwidthOut | Integer | Public network outbound bandwidth cap in Mbps. |
PublicIpAssigned | Boolean | Whether to assign a public IP. |
Key pair information.
Used by actions: CreateKeyPair, DescribeKeyPairs.
Name | Type | Description |
---|---|---|
KeyId | String | Key pair ID, which is the unique identifier of a key pair. |
KeyName | String | Key pair name. |
PublicKey | String | Public key (in plain text) of key pair. |
AssociatedInstanceIds | Array of String | List of IDs of instances associated with the key pair. Note: this field may return null, indicating that no valid values can be obtained. |
CreatedTime | Timestamp ISO8601 | Creation time in the format of YYYY-MM-DDThh:mm:ssZ according to ISO 8601 standard. UTC time is used Note: this field may return null, indicating that no valid values can be obtained. |
PrivateKey | String | Private key of key pair. Note: this field may return null, indicating that no valid values can be obtained. |
Login password information
Used by actions: CreateInstances.
Name | Type | Required | Description |
---|---|---|---|
AutoGeneratePassword | String | No | YES : Random password. In this case, Password cannot be specified. No : Custom. Password must be specified. |
Password | String | No | Instance login password. For Windows instances, the password must contain 12 to 30 characters of the following types. It cannot start with “/” and cannot include the username. |
KeyIds | Array of String | No |
Describes login settings of an instance.
Used by actions: DescribeInstances.
Name | Type | Description |
---|---|---|
KeyIds | Array of String | Key ID list. After a key is associated, you can use it to access the instance. Note: this field may return [], indicating that no valid values can be obtained. |
Changeable packages for the instance.
Used by actions: DescribeModifyInstanceBundles.
Name | Type | Description |
---|---|---|
ModifyPrice | Price | Price difference that you need to pay for the new instance package after change. |
ModifyBundleState | String | Package change status. Valid values: |
Bundle | Bundle | Package information. |
NotSupportModifyMessage | String | The reason of package changing failure. It’s empty if the package change status is AVAILABLE .Note: This field may return null , indicating that no valid values can be obtained. |
Discount details.
Used by actions: DescribeBundleDiscount, DescribeDiskDiscount, InquirePriceRenewInstances.
Name | Type | Description |
---|---|---|
UserDiscount | Integer | User discount. |
CommonDiscount | Integer | Public discount. |
FinalDiscount | Integer | Final discount. |
ActivityDiscount | Float | Activity discount. The value null indicates no discount.Note: This field may return null , indicating that no valid values can be obtained. |
DiscountType | String | Discount type. Valid values: user (user discount), common (discount displayed on the official website), activity (activity discount), null (no discount).Note: This field may return null , indicating that no valid values can be obtained. |
Price information
Used by actions: DescribeBundles, DescribeModifyInstanceBundles, InquirePriceCreateInstances, InquirePriceRenewInstances.
Name | Type | Description |
---|---|---|
InstancePrice | InstancePrice | Instance price. |
Region information.
Used by actions: DescribeRegions.
Name | Type | Description |
---|---|---|
Region | String | Region name, such as ap-guangzhou . |
RegionName | String | Region description, such as South China (Guangzhou). |
RegionState | String | Region availability status. Its value can only be AVAILABLE . |
IsChinaMainland | Boolean | Whether the region is in the Chinese mainland |
Parameter settings for renewing the monthly subscribed cloud disk
Used by actions: InquirePriceRenewDisks, RenewDisks.
Name | Type | Required | Description |
---|---|---|---|
Period | Integer | No | Renewal period |
RenewFlag | String | No | Whether to renew the disk automatically. Values:NOTIFY_AND_AUTO_RENEW : Trigger expiration notification and renew automatically; NOTIFY_AND_MANUAL_RENEW : Trigger expiration notification but do not renew; DISABLE_NOTIFY_AND_MANUAL_RENEW : Do not trigger the notification and do not renew.Default: NOTIFY_AND_MANUAL_RENEW . If NOTIFY_AND_AUTO_RENEW is specified, the instance is automatically renewed on a monthly basis when the account balance is sufficient. |
TimeUnit | String | No | Unit of the period. Values: m (month). |
CurInstanceDeadline | String | No | Expiration time of the current instance, such as "2018-01-01 00:00:00". Specify this parameter to align the expiration time of the instance and attached cloud disks. CurInstanceDeadline and Period cannot be both specified. |
Image reset information
Used by actions: DescribeResetInstanceBlueprints.
Name | Type | Description |
---|---|---|
BlueprintInfo | Blueprint | Image details |
IsResettable | Boolean | Whether the image can be reset as the target image |
NonResettableMessage | String | Non-Resettable flag. If the image is resettable, it will be "" |
Scene information
Used by actions: DescribeScenes.
Name | Type | Description |
---|---|---|
SceneId | String | Scene ID |
DisplayName | String | Display name of the scene |
Description | String | Scene description |
Scene information
Used by actions: DescribeAllScenes.
Name | Type | Description |
---|---|---|
SceneId | String | Scene ID |
DisplayName | String | Display name of the scene |
Description | String | Scene description |
Snapshot information.
Used by actions: DescribeSnapshots.
Name | Type | Description |
---|---|---|
SnapshotId | String | Snapshot ID. |
DiskUsage | String | Type of the disk for which the snapshot is created. Valid values: |
DiskId | String | ID of the disk for which the snapshot is created. |
DiskSize | Integer | Size of the disk in GB for which the snapshot is created. |
SnapshotName | String | Snapshot name, which is a custom snapshot alias. |
SnapshotState | String | Snapshot status. Valid values: |
Percent | Integer | Snapshot creation or rollback progress in percentage. After success, the value of this field will become 100. |
LatestOperation | String | Last snapshot operation. It is recorded only during snapshot creation and rollback. Example values: CreateInstanceSnapshot, RollbackInstanceSnapshot. Note: this field may return null, indicating that no valid values can be obtained. |
LatestOperationState | String | Last snapshot operation status. It is recorded only during snapshot creation and rollback. Valid values: Note: this field may return null, indicating that no valid values can be obtained. |
LatestOperationRequestId | String | Unique request ID for the last snapshot operation. It is recorded only during snapshot creation and rollback. Note: this field may return null, indicating that no valid values can be obtained. |
CreatedTime | Timestamp ISO8601 | Snapshot creation time. Note: This field may return null , indicating that no valid values can be obtained. |
List of snapshot operation limits.
Used by actions: DescribeSnapshotsDeniedActions.
Name | Type | Description |
---|---|---|
SnapshotId | String | Snapshot ID. |
DeniedActions | Array of DeniedAction | List of operation limits. |
Image software information.
Used by actions: DescribeBlueprintInstances.
Name | Type | Description |
---|---|---|
Name | String | Software name. |
Version | String | Software version. |
ImageUrl | String | Software picture URL. |
InstallDir | String | Software installation directory. |
DetailSet | Array of SoftwareDetail | List of software details. |
Image software details.
Used by actions: DescribeBlueprintInstances.
Name | Type | Description |
---|---|---|
Key | String | Unique detail key |
Title | String | Detail title. |
Value | String | Detail value. |
Information on the block device where the operating system is installed, namely the system disk.
Used by actions: DescribeInstances.
Name | Type | Description |
---|---|---|
DiskType | String | System disk type. Valid values: |
DiskSize | Integer | System disk size in GB. |
DiskId | String | System disk ID. Note: this field may return null, indicating that no valid values can be obtained. |
Information on tags
Used by actions: DescribeInstances.
Name | Type | Required | Description |
---|---|---|---|
Key | String | Yes | Tag key |
Value | String | Yes | Tag value |
Total price information
Used by actions: InquirePriceRenewInstances.
Name | Type | Description |
---|---|---|
OriginalPrice | Float | Total original price Note: This field may return null , indicating that no valid values can be obtained. |
DiscountPrice | Float | Total discounted price Note: This field may return null , indicating that no valid values can be obtained. |
Traffic package details.
Used by actions: DescribeInstancesTrafficPackages.
Name | Type | Description |
---|---|---|
TrafficPackageId | String | Traffic package ID. |
TrafficUsed | Integer | Used traffic in bytes during traffic package validity period. |
TrafficPackageTotal | Integer | Total traffic in bytes during traffic package validity period. |
TrafficPackageRemaining | Integer | Remaining traffic in bytes during traffic package validity period. |
TrafficOverflow | Integer | Traffic exceeding package amount in bytes during traffic package validity period. |
StartTime | Timestamp ISO8601 | Start time of traffic package validity period according to ISO 8601 standard. UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ. Note: this field may return null, indicating that no valid values can be obtained. |
EndTime | Timestamp ISO8601 | End time of traffic package validity period according to ISO 8601 standard. UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ. Note: this field may return null, indicating that no valid values can be obtained. |
Deadline | Timestamp ISO8601 | Traffic package expiration time according to ISO 8601 standard. UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ. Note: this field may return null, indicating that no valid values can be obtained. |
Status | String | Traffic package status: |
AZ details
Used by actions: DescribeZones.
Name | Type | Description |
---|---|---|
Zone | String | AZ |
ZoneName | String | Chinese name of AZ |
InstanceDisplayLabel | String | AZ tags on instance purchase page |
Was this page helpful?