tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
API Gateway
    Documentation
    Download PDF

    DescribeServicesStatus

    Last updated: 2024-10-10 21:40:45
    Download PDF

      1. API Description

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

      This API is used to query the list of one or more services and return relevant domain name, time, and other information.

      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: DescribeServicesStatus.
      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 No Integer Number of results to be returned. Default value: 20. Maximum value: 100.
      Offset No Integer Offset. Default value: 0.
      Filters.N No Array of Filter Filter. Valid values: ServiceId, ServiceName, NotUsagePlanId, Environment, IpVersion, InstanceId, NetType, EIAMAppId.

      3. Output Parameters

      Parameter Name Type Description
      Result ServicesStatus Service list query result.
      Note: this field may return null, indicating that no valid values can be obtained.
      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.

      4. Example

      Example1 Querying service list

      Input Example

      https://apigateway.tencentcloudapi.com/?Action=DescribeServicesStatus
&<Common request parameters>

      Output Example

      {
    "Response": {
        "Result": {
            "TotalCount": 1,
            "ServiceSet": [
                {
                    "ServiceId": "service-hrxy5qsm",
                    "ServiceName": "ddd",
                    "ServiceDesc": "",
                    "Protocol": "http",
                    "OuterSubDomain": "service-hrxy5qsm-1259027407.gz.apigw.tencentcs.com",
                    "InnerSubDomain": "",
                    "InnerHttpPort": 0,
                    "InnerHttpsPort": 0,
                    "CreatedTime": "2020-03-25T15:24:17Z",
                    "ModifiedTime": "2020-03-25T15:24:18Z",
                    "NetTypes": [
                        "OUTER"
                    ],
                    "IpVersion": "IPv4",
                    "ExclusiveSetName": "",
                    "AvailableEnvironments": [
                        "release"
                    ],
                    "TradeIsolateStatus": 0
                }
            ]
        },
        "RequestId": "7100a7b7-30ed-43c8-8d53-081afb6ecd8b"
    }
}

      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.
      FailedOperation.CamException
      InternalError Internal error.
      InternalError.CamException
      InternalError.DbException
      InternalError.OssException OSS internal request error. Please try again. If the problem persists, please contact the smart customer service or submit a ticket.
      InvalidParameter Incorrect parameter.
      InvalidParameterValue.InvalidFilterNotSupportedName The parameter value is incorrect.
      InvalidParameterValue.InvalidRegion Incorrect region.
      InvalidParameterValue.InvalidTagValues Incorrect tag parameters
      LimitExceeded The quota limit is exceeded.
      MissingParameter Missing parameter.
      OperationDenied Operation denied.
      RequestLimitExceeded The number of requests exceeds the frequency limit.
      ResourceInUse The resource is in use.
      ResourceInsufficient Insufficient resource.
      ResourceNotFound The resource does not exist.
      UnauthorizedOperation The operation is unauthorized.
      UnknownParameter Unknown parameter.
      UnsupportedOperation Unsupported operation.
      UnsupportedOperation.InvalidAction API error.
      UnsupportedOperation.RequestPostError
      Contact Us

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

      Contact Us
      Technical Support

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

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy