DescribeService
最近更新时间: 2025-10-20 17:06:00
1. 接口描述
接口请求域名： apigateway.api3.fincloud.tencent.cn。
本接口（DescribeService）用于查询一个服务的详细信息、包括服务的描述、域名、协议、创建时间、发布情况等信息。
默认接口请求频率限制：20次/秒。
接口更新时间：2021-11-23 11:26:55。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeService |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-08-08 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| ServiceId | 是 | 否 | String | 待查询的服务唯一 ID。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ServiceId | String | 服务唯一ID。 |
| AvailableEnvironments | String | 服务 环境列表。 |
| ServiceName | String | 服务名称。 |
| ServiceDesc | String | 服务描述。 |
| Protocol | String | 服务支持协议，可选值为http、https、http&https。 |
| CreatedTime | Datetime_iso | 服务创建时间。 |
| ModifiedTime | Datetime_iso | 服务修改时间。 |
| ExclusiveSetName | String | 独立集群名称。 |
| NetTypes | String | 网络类型列表，INNER为内网访问，OUTER为外网访问。 |
| InternalSubDomain | String | 内网访问子域名。 |
| OuterSubDomain | String | 外网访问子域名。 |
| InnerHttpPort | Int64 | 内网访问http服务端口号。 |
| InnerHttpsPort | Int64 | 内网访问https端口号。 |
| ApiTotalCount | Int64 | API总数。 |
| ApiIdStatusSet | ApiIdStatus | API列表。 |
| UsagePlanTotalCount | Int64 | 使用计划总数量。 |
| UsagePlanList | UsagePlan | 使用计划数组。 |
| IpVersion | String | IP版本。 |
| UserType | String | 此服务的用户类型。 |
| SetId | Int64 | 预留字段。 |
| Tags | Tag | 服务绑定的标签。 |
| InstanceId | String | 独享实例id |
| InstanceName | String | 独享实例name |
| SetType | String | 集群类型 |
| ProjectId | String | 项目ID |
| TceArch | String | CPU架构 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| ResourceNotFound.InvalidService | 对应服务不可见。 |
| InvalidParameter.FormatError | 参数格式错误。 |
| InternalError | 内部错误。 |
| AuthFailure | CAM签名/鉴权错误。 |
| DryRunOperation | DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| InvalidParameterValue.InvalidRegion | 地域错误。 |
| UnauthorizedOperation.AccessResource | 您没有权限访问资源。 |