查询服务列表状态

最近更新时间:2024-03-12 01:08:35

我的收藏

1. 接口描述

接口请求域名: apigateway.tencentcloudapi.com 。

本接口(DescribeServicesStatus)用于搜索查询某一个服务或多个服务的列表,并返回服务相关的域名、时间等信息。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeServicesStatus。
Version String 公共参数,本接口取值:2018-08-08。
Region String 公共参数,详见产品支持的 地域列表
Limit Integer 返回数量,默认为 20,最大值为 100。
示例值:10
Offset Integer 偏移量,默认为 0。
示例值:1
Filters.N Array of Filter 过滤条件。支持ServiceId、ServiceName、NotUsagePlanId、Environment、IpVersion、InstanceId、NetType、EIAMAppId。

3. 输出参数

参数名称 类型 描述
Result ServicesStatus 服务列表查询结果。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询服务列表状态

查询服务列表状态

输入示例

POST / HTTP/1.1
Host: apigateway.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeServicesStatus
<公共请求参数>

{
    "Limit": 0,
    "Offset": 0,
    "Filters": [
        {
            "Name": "abc",
            "Values": [
                "abc"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "Result": {
            "TotalCount": 0,
            "ServiceSet": [
                {
                    "InnerHttpsPort": 0,
                    "ServiceDesc": "abc",
                    "Protocol": "abc",
                    "ModifiedTime": "2020-09-22T00:00:00+00:00",
                    "NetTypes": [
                        "abc"
                    ],
                    "ExclusiveSetName": "abc",
                    "ServiceId": "abc",
                    "IpVersion": "abc",
                    "AvailableEnvironments": [
                        "abc"
                    ],
                    "ServiceName": "abc",
                    "OuterSubDomain": "abc",
                    "CreatedTime": "2020-09-22T00:00:00+00:00",
                    "InnerHttpPort": 1,
                    "InnerSubDomain": "abc",
                    "TradeIsolateStatus": 0,
                    "Tags": [
                        {
                            "Key": "abc",
                            "Value": "abc"
                        }
                    ],
                    "InstanceId": "abc",
                    "SetType": "abc",
                    "DeploymentType": "abc"
                }
            ]
        },
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
DryRunOperation DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。
FailedOperation 操作失败。
FailedOperation.CamException CAM异常
InternalError 内部错误。
InternalError.CamException CAM内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
InternalError.DbException 数据库操作失败,请稍后重试。若无法解决,请联系智能客服或提交工单。
InternalError.OssException oss内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
InvalidParameter 参数错误。
InvalidParameterValue.InvalidFilterNotSupportedName 参数取值错误。
InvalidParameterValue.InvalidRegion 地域错误。
InvalidParameterValue.InvalidTagValues 标签参数错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
RequestLimitExceeded 请求的次数超过了频率限制。
ResourceInUse 资源被占用。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。
UnsupportedOperation.InvalidAction 接口错误。
UnsupportedOperation.RequestPostError 请求Post失败