Updated on 2025-03-26 GMT+08:00

GetInstanceConnectionStatistic

Function

Obtain the connection usage of each component in a ROMA Connect instance.

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

ROMA Connect 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

-

String

-

Example Requests

None

Example Responses

Status code: 200

{
  "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
      }
    }
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.