Query the Remote Management Connections

Query the number of remote management connections.

Request URL

GET {base_url}/dm/open_api/v1/subscription/rm_connections

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String Pass the access token in the header.

Format: Bearer {access_token}.

Response parameters

Parameter Type Description
data Object <Details> The detailed information.
requestId String The unique ID of the request, which can be used to quickly locate the request.
status String Request result:
  • Success
  • Failed
time Long The response time.
Note: The YCM API response returns a timestamp, you can convert the timestamp to detailed date and time as needed. For more information, see Convert Timestamp to Local Date and Time.
Details
Parameter Type Description
connections Object <Connections> The detailed information of remote connections.
remoteManagementAccount Object <RM_Account> The detailed information of remote management account subscription.
remoteManagementPremiumAccount Object <RMP_Account> The detailed information of remote management premium account subscription.
Connections
Parameter Type Description
used Integer The number of the used remote connections.
capacity Integer The total number of the remote connections.
assignedToResellerUsed Integer The number of remote connections used by reseller.
assignedToResellerCapacity Integer The number of remote connections assigned to reseller.
RM_Account
Parameter Type Description
status String Subscription status.
  • Subscribed
  • Trial
  • Not Subscribed
expirationTime Long The expiration time of the subscription.
RMP_Account
Parameter Type Description
status String Subscription status.
  • Subscribed
  • Trial
  • Not Subscribed
expirationTime Long The expiration time of the subscription.

Example

Request example

GET /dm/open_api/v1/subscription/rm_connections HTTP/1.1
Host:ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NzM0OSwidmVyc2lvbiI6MTYzODk1OTkwOSwicmVmcmVzaFZlcnNpb24iOjE2NjM1NzIzNTN9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjYzNTc0MTUzLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJjZDEyZTE1My1iYjRiLTRjNzUtOTkxZC01ZDFlMzM4YzE3MDYiLCJjbGllbnRfaWQiOiJrcDl5eW50bXVlc3VrNWpvV3ZNa1RiQ0J4cU82TEtSaCJ9.6E_hI3HkpCr8obFYrwH35hWOhB56tNmoT9tW0PTVOOE
Response example
HTTP/1.1 200 OK
{
    "data": {
        "connections": {
            "used": 2,
            "capacity": 15,
            "assignedToResellerUsed": 0,
            "assignedToResellerCapacity": 1
        },
        "remoteManagementAccount": {
            "status": "Subscribed",
            "expirationTime": 1748658872
        },
        "remoteManagementPremiumAccount": {
            "status": "Subscribed",
            "expirationTime": 1748658872
        }
    },
    "requestId": "d13922856edfdde160a7d3e0bd899e5a",
    "status": "Success",
    "time": 1742363033
}