Obtaining the Number of Instance Connections

Function

This API is used to obtain the connection usage of each component in a ROMA Connect instance.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v1/{project_id}/roma/instances/{instance_id}/statistics

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Resource set ID.
instance_id	Yes	String	Instance ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
fdi	fdi object	Number of FDI connections.
apic	apic object	Number of APIC connections.
mqs	mqs object	Number of MQS connections.
link	link object	Number of LINK connections.

**Table 4** fdi
Parameter	Type	Description
connect_count	Integer	Number of connections.
all_datasource_count	Integer	Total number of data sources.
all_tasks_count	Integer	Total number of tasks.
all_running_tasks_count	Integer	Total number of running tasks.
all_common_tasks_count	Integer	Total number of common tasks.
running_common_tasks_count	Integer	Number of running common tasks.
abnormal_common_tasks_count	Integer	Number of abnormal common tasks.
terminated_common_tasks_count	Integer	Number of stopped common tasks.
completed_common_tasks_count	Integer	Number of completed common tasks.
all_cdc_tasks_count	Integer	Total number of CDC tasks.
running_cdc_tasks_count	Integer	Number of running CDC tasks.
abnormal_cdc_tasks_count	Integer	Number of abnormal CDC tasks.
terminated_cdc_tasks_count	Integer	Number of suspended CDC tasks.
completed_cdc_tasks_count	Integer	Number of completed CDC tasks.
all_flow_tasks_count	Integer	Total number of orchestration tasks.
running_flow_tasks_count	Integer	Number of running orchestration tasks.
abnormal_flow_tasks_count	Integer	Number of abnormal orchestration tasks.
terminated_flow_tasks_count	Integer	Number of stopped orchestration tasks.
completed_flow_tasks_count	Integer	Number of completed orchestration tasks.

**Table 5** apic
Parameter	Type	Description
connection_num	Integer	Number of connections.
api_num	Integer	Number of APIs.
api_num_without_livedata	Integer	Number of hosted APIs (not published by custom backends).
livedata_api_num	Integer	Number of custom backends (function backends or data backends).

**Table 6** mqs
Parameter	Type	Description
connection_numbers	Integer	Number of connections.
topic_numbers	Integer	Number of topics.
partition_numbers	Integer	Number of partitions.
consumer_group_numbers	Integer	Number of consumer groups.
total_queue_numbers	Integer	Number of queues.

**Table 7** link
Parameter	Type	Description
products	products object	Product connection information.
connections	connections object	Connection information.
product_templates	product_templates object	Product template.
devices	devices object	Device information.

**Table 8** products
Parameter	Type	Description
total	Integer	Total number.
normal_products_numbers	Integer	Number of common products.
gateway_products_numbers	Integer	Number of gateway products.

**Table 9** connections
Parameter	Type	Description
connection_numbers	Integer	Number of connections.

**Table 10** product_templates
Parameter	Type	Description
product_templates_numbers	Integer	Number of product templates.

**Table 11** devices
Parameter	Type	Description
total	Integer	Total number of devices.
normal_devices	normal_devices object	Common device information.
gateway_devices	gateway_devices object	Gateway device information.
subsets_devices	subsets_devices object	Gateway child device information.

**Table 12** normal_devices
Parameter	Type	Description
total	Integer	Total number.
never_connected	Integer	Unconnected common devices.
online	Integer	Online common devices.
offline	Integer	Offline common devices.

**Table 13** gateway_devices
Parameter	Type	Description
total	Integer	Total number.
never_connected	Integer	Unconnected gateway devices.
online	Integer	Online gateway devices.
offline	Integer	Offline gateway devices.

**Table 14** subsets_devices
Parameter	Type	Description
total	Integer	Total number.
never_connected	Integer	Unconnected gateway child devices.
online	Integer	Online gateway child devices.
offline	Integer	Offline gateway child devices.

Example Requests

None

Example Responses

Status code: 200

ROMA instance connection information.

{
  "fdi" : {
    "connect_count" : 0,
    "all_datasource_count" : 7,
    "all_tasks_count" : 0,
    "all_running_tasks_count" : 0,
    "all_common_tasks_count" : 0,
    "running_common_tasks_count" : 0,
    "abnormal_common_tasks_count" : 0,
    "terminated_common_tasks_count" : 0,
    "completed_common_tasks_count" : 0,
    "all_cdc_tasks_count" : 0,
    "running_cdc_tasks_count" : 0,
    "abnormal_cdc_tasks_count" : 0,
    "terminated_cdc_tasks_count" : 0,
    "completed_cdc_tasks_count" : 0,
    "all_flow_tasks_count" : 0,
    "running_flow_tasks_count" : 0,
    "abnormal_flow_tasks_count" : 0,
    "terminated_flow_tasks_count" : 0,
    "completed_flow_tasks_count" : 0
  },
  "apic" : {
    "connection_num" : 7,
    "api_num" : 37,
    "api_num_without_livedata" : 26,
    "livedata_api_num" : 18
  },
  "mqs" : {
    "connection_numbers" : 2,
    "topic_numbers" : 4,
    "partition_numbers" : 10,
    "consumer_group_numbers" : 0,
    "total_queue_numbers" : 0
  },
  "link" : {
    "products" : {
      "total" : 1,
      "normal_products_numbers" : 1,
      "gateway_products_numbers" : 0
    },
    "connections" : {
      "connection_numbers" : 1
    },
    "product_templates" : {
      "product_templates_numbers" : 0
    },
    "devices" : {
      "total" : 1,
      "normal_devices" : {
        "total" : 1,
        "never_connected" : 1,
        "online" : 0,
        "offline" : 0
      },
      "gateway_devices" : {
        "total" : 0,
        "never_connected" : 0,
        "online" : 0,
        "offline" : 0
      },
      "subsets_devices" : {
        "total" : 0,
        "never_connected" : 0,
        "online" : 0,
        "offline" : 0
      }
    }
  }
}