查询服务详情

1. 接口描述

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

本接口（DescribeService）用于查询一个服务的详细信息、包括服务的描述、域名、协议、创建时间、发布情况等信息。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 用于查询服务详情

无

输入示例

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

{
    "ServiceId": "service-rypiqi13"
}

输出示例

{
    "Response": {
        "ServiceDesc": "sesrxx",
        "CreatedTime": "2020-09-22T00:00:00+00:00",
        "SetId": 1,
        "InnerHttpsPort": 0,
        "InnerHttpPort": 0,
        "UniqVpcId": "vpc-abc",
        "Tags": [
            {
                "Value": "test",
                "Key": "test"
            }
        ],
        "NetTypes": [
            "OUTER"
        ],
        "IpVersion": "",
        "UserType": "",
        "UsagePlanList": [
            {
                "MaxRequestNumPreSec": 0,
                "UsagePlanId": "",
                "ModifiedTime": "2020-09-22T00:00:00+00:00",
                "UsagePlanDesc": "test",
                "Environment": "test",
                "CreatedTime": "2020-09-22T00:00:00+00:00",
                "UsagePlanName": "sdfafxx"
            }
        ],
        "OuterSubDomain": "domain.com",
        "UsagePlanTotalCount": 0,
        "SetType": "",
        "ApiIdStatusSet": [
            {
                "AuthType": "",
                "Protocol": "",
                "UniqVpcId": "",
                "ModifiedTime": "2020-09-22T00:00:00+00:00",
                "OauthConfig": {
                    "PublicKey": "",
                    "LoginRedirectUrl": "",
                    "TokenLocation": ""
                },
                "ApiId": "",
                "AuthRelationApiId": "",
                "ApiDesc": "",
                "ApiType": "",
                "ApiBusinessType": "",
                "ServiceId": "",
                "ApiName": "",
                "Path": "",
                "CreatedTime": "2020-09-22T00:00:00+00:00",
                "RelationBuniessApiIds": [
                    ""
                ],
                "IsDebugAfterCharge": false,
                "Method": "",
                "TokenLocation": ""
            }
        ],
        "ServiceName": "",
        "RequestId": "",
        "InstanceName": "",
        "Protocol": "",
        "ApiTotalCount": 1,
        "ModifiedTime": "2020-09-22T00:00:00+00:00",
        "DeploymentType": "DEFAULT",
        "SpecialUse": "DEFAULT",
        "InstanceId": "",
        "AvailableEnvironments": [
            "release"
        ],
        "ServiceId": "",
        "InternalSubDomain": ""
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

• Tencent Cloud SDK 3.0 for Python: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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