tencent cloud

Feedback

DescribeUpstreams

Last updated: 2022-05-05 16:49:41

1. API Description

Domain name for API request: apigateway.tencentcloudapi.com.

This API is used to query details of upstreams under the current account.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: DescribeUpstreams.
Version Yes String Common Params. The value used for this API: 2018-08-08.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Limit Yes Integer Number of entries per page
Offset Yes Integer The starting position of paging
Filters.N No Array of Filter Filters. Valid values: UpstreamId and UpstreamName

3. Output Parameters

Parameter Name Type Description
Result DescribeUpstreamInfo Query results
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying upstreams under the current account

Input Example

https://apigateway.tencentcloudapi.com/?Action=DescribeUpstreams
&Limit=1
&Offset=0
&<Common request parameters>

Output Example

{
  "Response": {
    "Result": {
      "TotalCount": 1,
      "UpstreamSet": [
        {
          "Retries": 1,
          "Algorithm": "xx",
          "UniqVpcId": "xx",
          "Tags": [
            {
              "Value": "xx",
              "Key": "xx"
            }
          ],
          "UpstreamType": "xx",
          "UpstreamHost": "xx",
          "UpstreamId": "xx",
          "K8sServices": [
            {
              "Name": "xx",
              "Weight": 0,
              "ClusterId": "xx",
              "Namespace": "xx",
              "ServiceName": "xx",
              "ExtraLabels": [
                {
                  "Value": "xx",
                  "Key": "xx"
                }
              ],
              "Port": 0
            }
          ],
          "UpstreamName": "xx",
          "HealthChecker": {
            "UnhealthyTimeout": 1,
            "ActiveCheckInterval": 1,
            "ActiveRequestHeader": [
              {}
            ],
            "TimeoutThreshold": 1,
            "HealthyHttpStatus": "xx",
            "TcpFailureThreshold": 1,
            "EnableActiveCheck": true,
            "UnhealthyHttpStatus": "xx",
            "ActiveCheckHttpPath": "xx",
            "EnablePassiveCheck": true,
            "HttpFailureThreshold": 1,
            "ActiveCheckTimeout": 1
          },
          "CreatedTime": "2020-09-22T00:00:00+00:00",
          "Nodes": [
            {
              "Weight": 1,
              "Tags": [
                "xx"
              ],
              "Healthy": "xx",
              "ClusterId": "xx",
              "NameSpace": "xx",
              "Source": "xx",
              "VmInstanceId": "xx",
              "Host": "xx",
              "ServiceName": "xx",
              "UniqueServiceName": "xx",
              "Port": 1
            }
          ],
          "Scheme": "xx",
          "UpstreamDescription": "xx"
        }
      ]
    },
    "RequestId": "xx"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure Error with CAM signature/authentication.
DryRunOperation DryRun Operation. It means that the request would have succeeded, but the DryRun parameter was used.
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Incorrect parameter.
LimitExceeded The quota limit is exceeded.
MissingParameter Missing parameter.
ResourceNotFound.InvalidAccessKeyId The key does not exist.
UnsupportedOperation Unsupported operation.
UnsupportedOperation.InvalidAction API error.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support