Check the remaining resources of ulhost - CheckULHostResourceCapacity
Overview
Check the remaining resources of ulhost
Definition
Public Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Action | string | Corresponding API command name, the current API is CheckULHostResourceCapacity. | Yes |
| PublicKey | string | The user’s public key can be obtained from Console | Yes |
| Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
| Parameter Name | Type | Description Information | Required |
|---|---|---|---|
| Region | string | Region. See List of Regions and Availability Zones | Yes |
| ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | No |
| ImageId | string | Image ID. Please obtain it through DescribeImage | Yes |
| BundleId | string | Package ID. For example: “ulh.c1m1s40b30t800”. | Yes |
| Name | string | Light application host name. Default: Package ID. Please set the instance name according to the field specification. | No |
| ChargeType | string | Billing Mode. Enumeration values: > Year, Yearly payment; > Month, Monthly payment; > ThirtyDay, 30-day payment, used for cross-border e-commerce related packages; Default: Month | No |
| Quantity | int | Purchase duration. Default: 1. Purchase until the end of the month is not supported. | No |
| VPCId | string | VPC ID. The default is the default VPC for the current region. | No |
| SubnetId | string | Subnet ID. The default is the default subnet for the current region. | No |
| SecurityGroupId | string | Firewall ID, default: Web recommended firewall. For how to query SecurityGroupId, please refer to DescribeFirewall. | No |
| CouponId | string | Host coupon ID. Please query through the DescribeCoupon interface, or log in to the user center to view. | No |
Response Field
| Field Name | Type | Description Information | Required |
|---|---|---|---|
| RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
| Action | string | Operation command name. | Yes |
| Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
| ResourceEnough | boolean | Is the resource fully charged | Yes |
Example
Request Example
https://api.dezai.com/?Action=CheckULHostResourceCapacity
&Region=cn-zj
&ProjectId=dkJFqRJJ
&ImageId=kBaGDyHc
&BundleId=EFKsULAJ
&Password=zmDlYNlz
&Name=bUBvNpbi
&ChargeType=lXBrlMtL
&Quantity=1
&VPCId=crUpJjJh
&SubnetId=cfTbEIRC
&SecurityGroupId=bCSqYcal
&BillActivityId=1
&BillActivityRuleId=2
&CouponId=LfMSIcznResponse Example
{
"Action": "CheckULHostResourceCapacityResponse",
"Message": "YIZvrfmX",
"RetCode": 0,
"ULHostId": "tRoNqJfI"
}