API 网关
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 网关 > API 文档 > 应用相关接口 > 应用使用者查询服务详情

应用使用者查询服务详情

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

我的收藏

本页目录：

1. 接口描述

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

本接口（DescribeServiceForApiApp）用于应用使用者查询一个服务的详细信息、包括服务的描述、域名、协议等信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeServiceForApiApp。
Version 是 String 公共参数，本接口取值：2018-08-08。
Region 是 String 公共参数，详见产品支持的 地域列表。
ServiceId 是 String 待查询的服务唯一 ID。
示例值：service-rypiqi13
ApiRegion 是 String 服务所属的地域
示例值：ap-guangzhou

3. 输出参数

参数名称 类型 描述
ServiceId String 服务唯一ID。
示例值：service-rypiqi13
AvailableEnvironments Array of String 服务 环境列表。
注意：此字段可能返回 null，表示取不到有效值。
示例值：["release"]
ServiceName String 服务名称。
注意：此字段可能返回 null，表示取不到有效值。
示例值：dd
ServiceDesc String 服务描述。
注意：此字段可能返回 null，表示取不到有效值。
示例值：test
Protocol String 服务支持协议，可选值为http、https、http&https。
示例值：http
CreatedTime Timestamp ISO8601 服务创建时间。
注意：此字段可能返回 null，表示取不到有效值。
示例值：2020-04-15T11:03:41Z
ModifiedTime Timestamp ISO8601 服务修改时间。
注意：此字段可能返回 null，表示取不到有效值。
示例值：2020-04-15T11:03:42Z
NetTypes Array of String 网络类型列表，INNER为内网访问，OUTER为外网访问。
示例值：["OUTER"]
InternalSubDomain String 内网访问子域名。
示例值：service-rypiqi13-1259027407.bj-in.apigw.tencentcs.com
OuterSubDomain String 外网访问子域名。
示例值：service-rypiqi13-1259027407.bj.apigw.tencentcs.com
InnerHttpPort Integer 内网访问http服务端口号。
示例值：0
InnerHttpsPort Integer 内网访问https端口号。
示例值：0
ApiTotalCount Integer API总数。
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
ApiIdStatusSet Array of ApiIdStatus API列表。
注意：此字段可能返回 null，表示取不到有效值。
UsagePlanTotalCount Integer 使用计划总数量。
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
UsagePlanList Array of UsagePlan 使用计划数组。
注意：此字段可能返回 null，表示取不到有效值。
IpVersion String IP版本。
注意：此字段可能返回 null，表示取不到有效值。
示例值：IPv4
UserType String 此服务的用户类型。
注意：此字段可能返回 null，表示取不到有效值。
示例值：xxx
SetId Integer 预留字段。
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
Tags Array of Tag 服务绑定的标签。
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeServiceForApiApp

应用使用者查询服务详情

输入示例

https://apigateway.tencentcloudapi.com/?Action=DescribeServiceForApiApp
&ServiceId=service-rypiqi13
&ApiRegion=ap-guangzhou
&<公共请求参数>

输出示例

{
    "Response": {
        "ServiceId": "abc",
        "AvailableEnvironments": [
            "abc"
        ],
        "ServiceName": "abc",
        "ServiceDesc": "abc",
        "Protocol": "abc",
        "CreatedTime": "2020-09-22T00:00:00+00:00",
        "ModifiedTime": "2020-09-22T00:00:00+00:00",
        "NetTypes": [
            "abc"
        ],
        "InternalSubDomain": "abc",
        "OuterSubDomain": "abc",
        "InnerHttpPort": 0,
        "InnerHttpsPort": 0,
        "ApiTotalCount": 0,
        "ApiIdStatusSet": [
            {
                "ServiceId": "abc",
                "ApiId": "abc",
                "ApiDesc": "abc",
                "Path": "abc",
                "Method": "abc",
                "CreatedTime": "2020-09-22T00:00:00+00:00",
                "ModifiedTime": "2020-09-22T00:00:00+00:00",
                "ApiName": "abc",
                "UniqVpcId": "abc",
                "ApiType": "abc",
                "Protocol": "abc",
                "IsDebugAfterCharge": true,
                "AuthType": "abc",
                "ApiBusinessType": "abc",
                "AuthRelationApiId": "abc",
                "RelationBuniessApiIds": [
                    "abc"
                ],
                "OauthConfig": {
                    "PublicKey": "abc",
                    "TokenLocation": "abc",
                    "LoginRedirectUrl": "abc"
                },
                "TokenLocation": "abc"
            }
        ],
        "UsagePlanTotalCount": 0,
        "UsagePlanList": [
            {
                "Environment": "abc",
                "UsagePlanId": "abc",
                "UsagePlanName": "abc",
                "UsagePlanDesc": "abc",
                "MaxRequestNumPreSec": 0,
                "CreatedTime": "2020-09-22T00:00:00+00:00",
                "ModifiedTime": "2020-09-22T00:00:00+00:00"
            }
        ],
        "IpVersion": "abc",
        "UserType": "abc",
        "SetId": 0,
        "Tags": [
            {
                "Key": "abc",
                "Value": "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. 错误码

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

错误码 描述
InvalidParameter.FormatError 参数格式错误。
ResourceNotFound.InvalidService 对应服务不可见。
中国站