Querying Agent Information by Agent Status in Pagination Mode

Scenario

This interface is invoked to query agent information in pagination mode by agent status.

Interface Method

This interface supports only the POST method.

Internal Encapsulation Interfaces

BMS interface: /ccbms/ws/monitor/siteagentinfobyagentids

URI

https://ip:port/rest/cmsapp/v1/openapi/vdn/queryAgentByStatus

In a public cloud environment, ip indicates the IP address of the CC-CMS server, and port indicates the HTTPS port number of the CC-CMS server. Contact the administrator to obtain the values.

In a non–public cloud environment where the NSLB service is configured, ip indicates the IP address of the NSLB server, and port indicates the HTTPS port number of the CC-CMS service mapped on the NSLB server.

Request Description

Response Description

Error Codes

None

Message Example

• Request header

  Content-Type: application/json;charset=UTF-8
  Authorization: ******************

• Request parameters

  {
    "ccId": "1","vdn": "3","status": "0","limit": 10,"offset": 0
  }

• Response parameters

  {
    "returnCode": "0",
    "data": [
      {
        "agentId": 108,
        "locationId": 65535,
        "currentStateTime": 426849,
        "currentState": 0
      },
      {
        "agentId": 109,
        "locationId": 65535,
        "currentStateTime": 426849,
        "currentState": 0
      }
    ],
    "description": "success"
  }