Updated on 2026-10-27 GMT+08:00

Obtains the ServiceBridge list.

Function

Obtains the ServiceBridge list.

Calling Method

For details, see Calling APIs.

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 /v2/{project_id}/fgs/servicebridge

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Parameter description:

Project ID. For details, see Obtaining a Project ID.

Constraints:

None

Value range:

32 characters, including letters and digits.

Default value:

None

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

String

Offset where the query starts.

limit

No

String

Maximum number of records that can be obtained in each query.

Maximum value: 400

The default value is 400, which is used when this parameter is not specified or is 0 or greater than 400.

If it is less than 0, an error is reported.

bridge_name

No

String

ServiceBridge name (fuzzy match is supported).

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Parameter description:

User token.

The token can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Constraints:

None

Value range:

None

Default value:

None

Content-Type

No

String

Parameter description:

Specifies the type (or format) of the message body.

Constraints:

None

Value range:

Only application/json is supported.

Default value:

application/json

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

service_bridges

Array of ListBridgeResult objects

ServiceBridge list.

next_marker

Long

Position for recording the next read.

count

Long

Total number of bridges that meet the search criteria.

Table 5 ListBridgeResult

Parameter

Type

Description

project_id

String

Tenant ID.

bridge_name

String

Name of a service bridge.

bridge_config

BridgeConfig object

ServiceBridge configuration structure.

bridge_id

String

Bridge ID, which is unique.

xrole

String

Configuration agency. You need to create an agency on the IAM console. This field is mandatory when a function needs to access other services. After specifying a function configuration agency, you can use the context method in the function handler to obtain a token, an AK, and an SK for accessing other cloud services. No agency is required if FunctionGraph does not access any cloud services.

bridge_vpc

FuncVpc object

VPC configuration. An agency with VPC permissions must be configured for the function.

Table 6 BridgeConfig

Parameter

Type

Description

data_source_type

String

Bridge type. The value can be rds, cache, mqs, or mqs-consumer.

rds_config

RdsConfig object

RDS bridge configuration structure.

cache_config

CacheConfig object

Cache bridge configuration structure.

mqs_config

MqsConfig object

MQS bridge configuration structure.

Table 7 RdsConfig

Parameter

Type

Description

database_type

String

Database type. The value can be mariadb, postgresql, or mysql.

database_address

String

IP address of the database.

database_name

String

Database name

user_name

String

Username.

password

String

Password.

max_connections

String

Maximum number of connections.

max_wait

String

Max. Connection Timeout (ms)

max_active

String

Maximum number of connections supported by the connection pool.

initial_size

String

Number of initial connections.

min_idle

String

Minimum number of idle connections.

remove_abandoned_timeout

String

Connection Idle Timeout (s)

remove_abandoned

String

Reclaim Idle Connections

enable_ssl

String

Allow SSL.

Table 8 CacheConfig

Parameter

Type

Description

cache_type

String

Cache type. The value can be redis_single or redis_cluster.

client_name

String

Redis Client Name

address

String

Cache address.

database

String

Database number.

user_name

String

Username.

password

String

Password.

max_connections

String

Maximum number of connections.

max_wait

String

Max. Connection Timeout (ms)

max_active

String

Maximum number of connections supported by the connection pool.

max_idle

String

Maximum number of idle connections in the pool.

min_idle

String

Minimum number of idle connections.

connection_timeout

String

Connection Timeout (ms)

socket_timeout

String

Socket timeout interval (ms).

max_attempts

String

Retry Attempts

enable_ssl

String

Allow SSL.

Table 9 MqsConfig

Parameter

Type

Description

mqs_address

String

MQS Address

mqs_account_config

MqsAccountConfig object

MQS bridge account information structure.

is_encrypt_transport

String

Allow encrypted transmission.

max_connections

String

Maximum number of connections.

max_active

String

Maximum number of topics supported by a bridge.

topics

String

topic.

Table 10 MqsAccountConfig

Parameter

Type

Description

auth_type

String

Account information and authentication mode.

enterprise

String

Enterprise Project

project_id

String

Project ID.

account

String

Account.

account_secret

String

Account password.

app_id

String

App ID.

app_secret

String

Specifies the app password.

Table 11 FuncVpc

Parameter

Type

Description

domain_id

String

Parameter description:

Tenant account ID.

Value range:

None

namespace

String

Parameter description:

Project ID.

Value range:

None

vpc_name

String

Definition:

VPC name

Value range:

None

vpc_id

String

Parameter description:

VPC ID.

Value range:

None

subnet_name

String

Parameter description:

Subnet name.

Value range:

None

subnet_id

String

Parameter description:

Subnet ID.

Value range:

None

cidr

String

Parameter description:

Subnet mask.

Value range:

None

gateway

String

Parameter description:

Gateway.

Value range:

None

security_groups

Array of strings

Parameter description:

Security Group

Value range:

Character string list

is_safety

Boolean

Definition

Whether to enable secure access. When secure access is enabled, you need to configure the VPCEP network to establish a secure VPC connection to private domain names. Once enabled, this feature cannot be disabled.

Range

  • true: Yes

  • false: No

Status code: 401

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 14 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 15 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

ServiceBridge list of the current tenant.

GET https://{Endpoint}/v2/{project_id}/fgs/servicebridge?offset=0&limit=400

Example Responses

Status code: 200

{
  "service_bridges" : [ {
    "bridge_name" : "test",
    "project_id" : "xxxxx",
    "bridge_config" : {
      "data_source_type" : "rds"
    }
  } ],
  "next_marker" : 4
}

Status Codes

Status Code

Description

200

ok

401

Unauthorized.

403

Forbidden.

404

Not found.

500

Internal server error.

Error Codes

See Error Codes.