Scenarios
Service Management is the core module in the AI Gateway for uniformly managing backend service addresses. By registering backend services in this module, you can quickly reference them in scenarios such as creating MCP services, configuring routes, and setting rate limits. This avoids repeatedly entering service addresses and facilitates centralized maintenance.
Services are categorized into the following two types based on their backend access methods.
Domain Name/IP: The backend service is accessed via a fixed domain name or IP address, and the gateway directly connects to the backend service.
Private DNS: Backend services are accessed via private domain names, and the gateway uses Tencent Cloud Private DNS to perform domain name resolution.
This document describes how to create and manage these two types of services.
Prerequisites
The Tencent Cloud AI Gateway service has been activated.
The AI Gateway instance has been created.
The backend service has been deployed and is accessible (network connectivity is established).
(Private DNS type) has been configured with the corresponding domain name's resolution records in Tencent Cloud Private DNS.
(Private DNS type) A service source of the Private DNS type has been created.
Operation Steps
Scenario 1: Creating a Domain/IP address-Based Service
Scenarios
Backend services are accessed via fixed domain names or IP addresses, eliminating the need for Private DNS to perform domain name resolution. This is suitable for:
The backend service address is fixed and does not change.
Access using a public domain name or public IP address.
Access directly using a private IP address.
Prerequisites
The backend service has been deployed and is accessible via a domain name or IP address.
The complete address of the backend service (protocol + domain name/IP address + port + path) has been confirmed.
Operation Steps
Step 1: Go to the Service Management page
2. Click the ID/Name of the target instance to go to its details page and access the target gateway instance.
3. In the left sidebar, choose Service Management > Services.
4. Click the New button.
Step 2: Select a service type and fill in the parameters.
In the New Service pop-up window, enter the following parameters:
|
Service Name | Yes | A custom name. Up to 60 characters. Supports uppercase and lowercase letters in Chinese and English, digits, and the - and _ symbols. Cannot start with a digit or separator. Cannot end with a separator. |
Service type | Yes | Domain name/IP |
Service Protocol | Yes | HTTP: Standard HTTP protocol. HTTPS: Encrypted HTTPS protocol. |
Service Address | Yes | Enter the domain name or IP address of the backend service (without the protocol header). Example (domain name): backend-server.example.com Example (IP address): 192.168.1.100 |
Service port | Yes | The port number of the backend service. Any port from 1-65535 is supported. |
Service Path | Yes | The path of the backend service (for example: /api/v1). If there is no path, enter /. |
Timeout Time | Yes | The timeout duration for gateway requests to the backend. The default is 60000 milliseconds, and it is adjustable. |
Number of retries | Yes | The number of retries when a request fails. The default is 5, and it is adjustable. |
Step 3: Save the configuration.
1. Confirm that all parameters are entered correctly.
2. Click the OK button to complete the creation.
3. The system automatically redirects to the Service List page.
Verifying the Result
On the Service List page, view the newly created service record.
The Service Type column displays "Domain Name/IP".
The Service Address column displays the complete backend address (protocol + domain name/IP address + port + path).
When creating an MCP service or configuring a route, you can select the service from the service drop-down list.
Notes
When entering the service address, do not include the protocol header (such as http:// or https://). Select the protocol separately in the Service Protocol field.
The service address can be a domain name or an IP address, but you must ensure that the gateway instance can access it.
When using a public domain name, ensure that the gateway instance has public network access capability.
When using a private IP address, ensure that the gateway instance and the backend service are in the same VPC or that network connectivity has been configured between them.
Use the HTTPS protocol to ensure secure data transmission.
Timeout duration and retry quantity can be adjusted based on the actual response of the backend service.
Scenario 2: Creating a Private DNS-Based Service
Scenarios
Backend services are accessed via private domain names on the private network, and domain name resolution is managed by the Tencent Cloud Private DNS service. This applies to:
Enterprise private network services are accessed via private domain names.
Scenarios that require integration with Tencent Cloud Private DNS.
Scenarios where backend service addresses require dynamic resolution.
Prerequisites
The resolution records for the corresponding domain name have been configured in Tencent Cloud Private DNS.
The backend service has been deployed and is accessible via a private domain name.
Operation Steps
Step 1: Go to the Service Management page.
2. Click the ID/Name of the target instance to go to its details page and access the target gateway instance.
3. In the left sidebar, choose Service Management > Services.
4. Click the New button,
Step 2: Select a service type and fill in the parameters.
In the New Service pop-up window, enter the following parameters:
|
Service Name | Yes | A custom name. Up to 60 characters. Supports uppercase and lowercase letters in Chinese and English, digits, and the - and _ symbols. Cannot start with a digit or separator. Cannot end with a separator. |
Service type | Yes | Select Private DNS |
Service Source | Yes | Select the configured Private DNS-type service source from the dropdown list. Click the refresh button to update the service source list. |
Service Protocol | Yes | HTTP: Standard HTTP protocol. HTTPS: Encrypted HTTPS protocol. |
Private DNS | Yes | Enter the private domain name of the backend service (e.g., backend-server.internal.example.com). |
Service port | Yes | The port number of the backend service. Any port from 1-65535 is supported. Note: If a port is already specified in the SRV record, the port content entered in the console will override the port content in the SRV record. |
Service Path | Yes | The path of the backend service (for example: /api/v1). If there is no path, enter /. |
Timeout Time | Yes | The timeout duration for gateway requests to the backend. The default is 60000 milliseconds, and it is adjustable. |
Number of retries | Yes | The number of retries when a request fails. The default is 5, and it is adjustable. |
Step 3: Save the configuration
1. Confirm that all parameters are entered correctly.
2. Click the OK button to complete the creation.
3. The system automatically redirects to the Service List page.
Verifying the Result
On the Service List page, view the newly created service record.
The Service Type column displays "Private DNS".
The Service Address column displays the private domain name and the full address.
When creating an MCP service or configuring a route, you can select the service from the service drop-down list.
Notes
The private domain name must have a resolution record configured in Tencent Cloud Private DNS. Otherwise, the service call will return a domain name resolution failure error.
If the SRV record already contains a port, the port in the SRV record will be overridden by the service port specified in the console.
The Private DNS service source must be created first before you can select it when you are creating a new service.
Ensure that the VPC associated with the private domain name's resolution record includes the VPC where the gateway instance resides.
Regularly check whether the resolution records in Private DNS are correct to avoid service call failures.
Service Management Operations
Viewing Service List
On the Service List page, you can view the following information:
ID/Name: the unique identifier and name of the service.
Service Type: Domain Name/IP address or Private DNS
Service Address: the complete backend address (protocol + domain name/IP address + port + path)
Rate Limiting: whether a rate limiting policy is configured.
Creation Time: the time when the service was created
Modification Time: the time when the service was last modified
Actions: operation buttons such as Edit and Delete
Editing a Service
1. On the Service List page, click the Edit button for the target service.
2. In the edit dialog, modify the service parameters (the service type cannot be modified).
3. Click the OK button to save the modifications.
Note:
The service type (Domain Name/IP address / Private DNS) cannot be modified once it is created. If you need to change it, create a new service.
Deleting a Service
1. On the Service List page, click the Delete button for the target service.
2. In the confirmation dialog, click the OK button.