Obtaining the Connection List

project_id

Yes

String

Tenant resource space ID.

offset

No

Integer

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

limit

No

Integer

Number of records displayed on each page. The value must be within the range [1, 1000].

sort

No

String

Sorting mode of the query results.

name

No

String

Name of the connection. It is used for exact match.

fuzzy_name

No

String

Name of the connection. It is used for fuzzy match.

instance_id

No

String

Queue instance ID of the connection.

X-Auth-Token

Yes

String

User token. The token 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.

total

Integer

Total number of records.

size

Integer

Number of records displayed on the current page.

items

Array of ConnectionInfo objects

Object list.

id

String

ID of the event source.

name

String

Name of the connection. The value must be unique under a tenant. Only lowercase letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. It must start with a letter or digit and cannot be default.

description

String

Description of the connection.

status

String

Status of the connection.

error_info

ErrorInfo object

Error message.

vpc_id

String

ID of the VPC to be connected.

subnet_id

String

ID of the subnet to be connected.

agency

String

Name of the user agency used by the target private network connection.

flavor

flavor object

Flavor.

type

String

Connection type, which can be webhook (HTTP connection) or kafka (Huawei Cloud Kafka instance).

kafka_detail

KafkaConnectionDetail object

Kafka connection parameters.

created_time

String

UTC time when the connection is created.

updated_time

String

UTC time when the connection is updated.

error_code

String

Error code.

error_detail

String

Error details.

error_msg

String

Error message.

name

String

Flavor name.

concurrency_type

String

Concurrent flavor type.

concurrency

Integer

Number of concurrent requests.

bandwidth_type

String

Bandwidth type.

instance_id

String

Kafka instance ID.

addr

String

Kafka connection address.

security_protocol

String

Security protocol.

enable_sasl_ssl

Boolean

Whether SASL_SSL is enabled for the Kafka instance.

user_name

String

Username of the Kafka instance. This parameter is mandatory when SASL_SSL is enabled for the instance.

password

String

Password of the Kafka instance. This parameter is mandatory when SASL_SSL is enabled for the instance.

acks

String

Number of acknowledgments that the producer requires the server to return before considering a request complete. This controls the durability of records that are sent. Supported options:

0: The producer will not wait for any acknowledgment from the server at all. The record will be immediately added to the socket buffer and considered sent. No guarantee can be made that the server has received the record, and the retries configuration will not take effect (as the client generally does not know of any failures). The offset given back for each record will always be set to -1.

1: The leader will write the record to its local log but will respond without waiting until receiving full acknowledgement from all followers. If the leader fails immediately after acknowledging the record but before the followers have replicated it, the record will be lost.

all: The leader will wait for the full set of replicas to acknowledge the record. This is the strongest available guarantee because the record will not be lost even if there is just one replica that works. min.insync.replicas specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful.

200

Operation successful.