Domain name for API request: tse.intl.tencentcloudapi.com.
Query the instance list of the gateway service source
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeNativeGatewayServiceSources. |
| Version | Yes | String | Common Params. The value used for this API: 2020-12-07. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| GatewayID | Yes | String | Gateway instance ID |
| Limit | Yes | Integer | Items per page. Maximum value: 100. |
| Offset | Yes | Integer | Pagination offset. |
| SourceID | No | String | Service Source ID |
| SourceName | No | String | Service Source Instance Name, Fuzzy Search |
| SourceTypes.N | No | Array of String | Microservice engine type: TSE-Nacos｜TSE-Consul｜TSE-PolarisMesh｜Customer-Nacos｜Customer-Consul｜Customer-PolarisMesh |
| OrderField | No | String | Sorting field data type, currently only support SourceName |
| OrderType | No | String | Sorting type, AES/DESC |
| Parameter Name | Type | Description |
|---|---|---|
| Total | Integer | Total instances |
| List | Array of NativeGatewayServiceSourceItem | Service source instance list |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: tse.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNativeGatewayServiceSources
<Common request parameters>
{
"SourceID": "ins-5ef8277d",
"SourceName": "nacos-learn-prod",
"OrderType": "AES",
"Limit": 1,
"SourceTypes": [
"TSE-Nacos"
],
"OrderField": "SourceName",
"Offset": 1,
"GatewayID": "gateway-dde03567"
}
{
"Response": {
"List": [
{
"GatewayID": "gateway-dde03567",
"SourceID": "ins-5ef8277d",
"SourceName": "nacos-learn-prod",
"SourceType": "TSE-Nacos",
"SourceInfo": {
"VpcInfo": {
"VpcID": "vpc-83p03121",
"SubnetID": "subnet-83p03121"
},
"Addresses": [
"10.0.0.1:8848"
],
"Auth": {
"Username": "tse@tencentUser",
"Password": "tse@tencentPwd",
"AccessToken": ""
}
},
"CreateTime": "2024-12-09 18:11:19",
"ModifyTime": "2024-12-09 18:11:19"
}
],
"RequestId": "0bcf3f70-550e-439d-81ee-7ebe260c2f06",
"Total": 3
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError.QueryError | Query internal error. |
| InvalidParameterValue.QueryError | Invalid request parameter. Query failed. |
| ResourceNotFound.InstanceNotFound | The instance does not exist. |
| ResourceNotFound.ResourceNotFound | The resource does not exist. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback