Перейти до вмісту
FlySIPFlySIP Docs

Get environment information

Цей контент ще не доступний вашою мовою.

getEnvironmentInfo returns every attribute of a virtual environment: the same fields that createEnvironment accepts, plus its state. Only the root customer of the root environment can call it.

The method supports trusted mode with i_customer, the ID of the root customer.

Parameters

Section titled “Parameters”
Name Type Required Description
i_environment int yes ID of the environment

Returns

Section titled “Returns”
Name Type Description
result string OK
environment struct The environment’s attributes, named as the parameters of createEnvironment, plus the members below
Name Type Description
i_environment int ID of the environment
enabled boolean True when the environment is started
suspend_date string When the environment was suspended, in the format of expiration_date (09:57:29.000 GMT Wed Nov 18 2026). Nil when it is not suspended
pending_action string The queued action still in progress, see queueEnvironmentAction. Empty or nil when none
db_info struct Databases of the environment and their sizes, as in listEnvironments

Example

Section titled “Example”
request
call("getEnvironmentInfo", {"i_environment": 4})
response
{
    "result": "OK",
    "environment": {
        "i_environment": 4,
        "name": "partner-a",
        "https_cname": "partner-a.example.com",
        "assigned_ips": "192.0.2.20",
        "description": "Partner A wholesale",
        "max_cps": 20,
        "max_sessions": 200,
        "installed_modules": None,
        "expiration_date": "23:59:59.000 GMT Fri Dec 31 2027",
        "notify_on_expiration": True,
        "notify_addresses": "< E-Mail, CC, BCC >",
        "company_name": "Partner A Ltd",
        "email": "noc@partner-a.example.com",
        "enabled": True,
        "suspend_date": None,
        "pending_action": "",
        # … the other createEnvironment fields and db_info
    },
}
Section titled “Related”