Query Remaining Space

Request

Body Params multipart/form-data

token

string

required

Token generated by the management backend.

Example:

domain_id

string

optional

Domain ID (can be obtained from the GetMX management backend or through the /v1/domain/list endpoint; the 'id' field is the 'domain_id')

Example:

12345678

group_pay_id

string

optional

Group pay ID (group_pay_id can be obtained from the GetMX backend or through the /v1/group-pay/list endpoint, with the 'id' field corresponding to 'group_pay_id').

Example:

12345678

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://domain-open-api.getmx.com/v1/vip-ip/available-space/calc' \
--form 'token="token"' \
--form 'domain_id="12345678"' \
--form 'group_pay_id="12345678"'

Responses

🟢200成功

application/json

Body

code

integer

required

msg

string

required

data

object

required

message_available_space_per

number

required

System Remaining Percentage: The percentage of remaining space on the system, with a total value of 1.

message_available_space_size

number

required

System Remaining Space: The amount of remaining space on the system, measured in gigabytes (G).

space_expansion_status

integer

required

Space Expansion Status: Indicates whether space expansion has been performed. 1: Expanded -1: Not Expanded

system_available_space_per

number

required

Email Remaining Percentage: The percentage of remaining space for emails, with a total value of 1. This value is only returned for servers that have undergone space expansion.

system_available_space_size

number

required

Email Remaining Space: The amount of remaining space for emails, measured in gigabytes (G). This value is only returned for servers that have undergone space expansion.

Example

{
  "code": 200,
  "msg": "成功",
  "data": {
    "message_available_space_per": 0.977,
    "message_available_space_size": 97,
    "space_expansion_status": 1,
    "system_available_space_per": 0.7525,
    "system_available_space_size": 37.625
  }
}