Create a service registry connection on a gateway group

POST /api/gateway_groups/{gateway_group_id}/service_registries

Create a service registry connection on a gateway group

IAM Action: gateway:ConnectServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s

Parameters

• gateway_group_id (path, string, required): Gateway group ID.

Request body

Content type: application/json

• allOf variant 1
• name (string, optional): The object name.
• description (string, optional): Service registry description.
• health_check (object, optional): Health check configurations.
• health_check.probe_interval (integer, optional): The time interval for checking service registry (in seconds).
• health_check.probe_timeout (integer, optional): The timeout for checking service registry (in seconds).
• allOf variant 2
• oneOf variant 1: Kubernetes
• type (string, required): The kubernetes service type.
• kubernetes_config (object, required): Kubernetes service registry configurations.
• kubernetes_config.service (object, optional): The IP address of the Kubernetes API server.
• kubernetes_config.service.schema (string, required):
• kubernetes_config.service.host (string, required): The HTTP host.
• kubernetes_config.service.port (string, required):
• kubernetes_config.namespace_selector (object,null, optional): The namespace selector to filter target namespaces.
• kubernetes_config.namespace_selector.equal (string, optional): Value to match namespaces whose name is exactly equal to the specified string.
• kubernetes_config.namespace_selector.not_equal (string, optional): Value to exclude namespaces whose name is exactly equal to the specified string.
• kubernetes_config.namespace_selector.match (array, optional): List of values to match namespaces whose names match any of the specified strings.
• kubernetes_config.namespace_selector.not_match (array, optional): List of values to exclude namespaces whose names match any of the specified strings.
• oneOf variant 1: Equal
• oneOf variant 2: Not Equal
• oneOf variant 3: Match
• oneOf variant 4: Not Match
• kubernetes_config.label_selector (string, optional): The label selector to filter target endpoints.
• kubernetes_config.client (object, optional): The client name.
• oneOf variant 1: Token File
• kubernetes_config.client.token_file (string, required): The path to the token file of the Kubernetes service account.
• oneOf variant 2: Token Value
• kubernetes_config.client.token (string, required): The token of the Kubernetes service account.
• oneOf variant 2: Nacos
• type (string, required): The Nacos service type.
• nacos_config (object, required): Nacos service registry configurations.
• nacos_config.hosts (array, required): The address of the Nacos API server.
• nacos_config.prefix (string, optional): The prefix of the Nacos API.
• nacos_config.default_weight (integer, optional): The default weight of the endpoints.
• nacos_config.fetch_interval (integer, optional): The interval for fetching endpoints (in seconds).
• nacos_config.timeout (object, optional): Timeout settings for connecting to, sending requests to, and receiving responses from Nacos, in seconds.
• nacos_config.timeout.connect (integer, optional): Connection timeout.
• nacos_config.timeout.send (integer, optional): Sending timeout in seconds.
• nacos_config.timeout.read (integer, optional): Reading timeout in seconds.
• nacos_config.auth (object, optional): Nacos authentication configuration.
• oneOf variant 1: Username & Password
• nacos_config.auth.username (string, required): The username of the Nacos API.
• nacos_config.auth.password (string, required): The password of the Nacos API.
• oneOf variant 2: Token
• nacos_config.auth.token (string, required): The token of the Nacos service.
• oneOf variant 3: Access Key & Secret Key
• nacos_config.auth.access_key (string, required): The access key of the Nacos API.
• nacos_config.auth.secret_key (string, required): The secret key of the Nacos API.
• oneOf variant 3: Consul
• type (string, required): The Consul service type.
• consul_config (object, required): Consul service registry configurations.
• consul_config.servers (array, required): The addresses of the Consul servers.
• consul_config.token (string, optional): The ACL token for authenticating with Consul.
• consul_config.weight (integer, optional): The default weight of the discovered endpoints.
• consul_config.fetch_interval (integer, optional): The interval for fetching endpoints (in seconds).
• consul_config.timeout (object, optional): Timeout settings for connecting to, sending requests to, and receiving responses from Consul, in seconds.
• consul_config.timeout.connect (integer, optional): Connection timeout.
• consul_config.timeout.send (integer, optional): Sending timeout in seconds.
• consul_config.timeout.read (integer, optional): Reading timeout in seconds.

Responses

• 200: Successfully retrieved or modified the service registry connection.
• allOf variant 1
• value (object, optional): The specific resource.
• allOf variant 2
• value (object, optional):
• allOf variant 1
• allOf variant 1
• allOf variant 1
• value.name (string, optional): The object name.
• value.description (string, optional): Service registry description.
• value.health_check (object, optional): Health check configurations.
• value.health_check.probe_interval (integer, optional): The time interval for checking service registry (in seconds).
• value.health_check.probe_timeout (integer, optional): The timeout for checking service registry (in seconds).
• allOf variant 2
• oneOf variant 1: Kubernetes
• value.type (string, required): The kubernetes service type.
• value.kubernetes_config (object, required): Kubernetes service registry configurations.
• value.kubernetes_config.service (object, optional): The IP address of the Kubernetes API server.
• value.kubernetes_config.service.schema (string, required):
• value.kubernetes_config.service.host (string, required): The HTTP host.
• value.kubernetes_config.service.port (string, required):
• value.kubernetes_config.namespace_selector (object,null, optional): The namespace selector to filter target namespaces.
• value.kubernetes_config.namespace_selector.equal (string, optional): Value to match namespaces whose name is exactly equal to the specified string.
• value.kubernetes_config.namespace_selector.not_equal (string, optional): Value to exclude namespaces whose name is exactly equal to the specified string.
• value.kubernetes_config.namespace_selector.match (array, optional): List of values to match namespaces whose names match any of the specified strings.
• value.kubernetes_config.namespace_selector.not_match (array, optional): List of values to exclude namespaces whose names match any of the specified strings.
• oneOf variant 1: Equal
• oneOf variant 2: Not Equal
• oneOf variant 3: Match
• oneOf variant 4: Not Match
• value.kubernetes_config.label_selector (string, optional): The label selector to filter target endpoints.
• value.kubernetes_config.client (object, optional): The client name.
• oneOf variant 1: Token File
• value.kubernetes_config.client.token_file (string, required): The path to the token file of the Kubernetes service account.
• oneOf variant 2: Token Value
• value.kubernetes_config.client.token (string, required): The token of the Kubernetes service account.
• oneOf variant 2: Nacos
• value.type (string, required): The Nacos service type.
• value.nacos_config (object, required): Nacos service registry configurations.
• value.nacos_config.hosts (array, required): The address of the Nacos API server.
• value.nacos_config.prefix (string, optional): The prefix of the Nacos API.
• value.nacos_config.default_weight (integer, optional): The default weight of the endpoints.
• value.nacos_config.fetch_interval (integer, optional): The interval for fetching endpoints (in seconds).
• value.nacos_config.timeout (object, optional): Timeout settings for connecting to, sending requests to, and receiving responses from Nacos, in seconds.
• value.nacos_config.timeout.connect (integer, optional): Connection timeout.
• value.nacos_config.timeout.send (integer, optional): Sending timeout in seconds.
• value.nacos_config.timeout.read (integer, optional): Reading timeout in seconds.
• value.nacos_config.auth (object, optional): Nacos authentication configuration.
• oneOf variant 1: Username & Password
• value.nacos_config.auth.username (string, required): The username of the Nacos API.
• value.nacos_config.auth.password (string, required): The password of the Nacos API.
• oneOf variant 2: Token
• value.nacos_config.auth.token (string, required): The token of the Nacos service.
• oneOf variant 3: Access Key & Secret Key
• value.nacos_config.auth.access_key (string, required): The access key of the Nacos API.
• value.nacos_config.auth.secret_key (string, required): The secret key of the Nacos API.
• oneOf variant 3: Consul
• value.type (string, required): The Consul service type.
• value.consul_config (object, required): Consul service registry configurations.
• value.consul_config.servers (array, required): The addresses of the Consul servers.
• value.consul_config.token (string, optional): The ACL token for authenticating with Consul.
• value.consul_config.weight (integer, optional): The default weight of the discovered endpoints.
• value.consul_config.fetch_interval (integer, optional): The interval for fetching endpoints (in seconds).
• value.consul_config.timeout (object, optional): Timeout settings for connecting to, sending requests to, and receiving responses from Consul, in seconds.
• value.consul_config.timeout.connect (integer, optional): Connection timeout.
• value.consul_config.timeout.send (integer, optional): Sending timeout in seconds.
• value.consul_config.timeout.read (integer, optional): Reading timeout in seconds.
• allOf variant 2
• value.id (string, optional): The object ID.
• value.gateway_group_id (string, optional): The gateway group ID.
• value.created_at (integer, optional): The object created timestamp.
• value.updated_at (integer, optional): The object updated timestamp.
• allOf variant 2
• value.status (string, optional): The status of the service registry.
• value.last_connect_time (integer, optional): The object timestamp.
• 400: Invalid arguments. Error details will be provided in the response.

cURL

curl -X POST '$API_BASE_URL/api/gateway_groups/{gateway_group_id}/service_registries'