1. 接口描述
接口请求域名： tbdsnew.api3.fincloud.tencent.com。
配置页面拉取文件所在IP列表
默认接口请求频率限制：20次/秒。
接口更新时间：2024-12-06 09:57:34。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeFileIps |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-01-03 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 实例Id 示例值： tbds-664nmwbe |
| ConfFileName | 是 | 否 | String | 配置文件名 示例值： allMixed |
| Offset | 是 | 否 | Int64 | 页编号，默认值为0，表示第一页 示例值： 0 |
| Limit | 是 | 否 | Int64 | 每页返回数量，默认值为10，最大值为100 示例值： 10 |
| ServiceType | 是 | 否 | Int64 | 服务类型，0: zookeeper 1: hdfs 2: yarn 3: hbase 4 :hive 5 : presto 示例值： 1 |
| Ip | 是 | 否 | String | Ip列表，通过逗号进行分隔 示例值： |
| NodeFlag | 否 | 否 | Int64 | 节点标志，1表示master,2表示core,3表示task,4表示common -99表示all,-1表示router，如果NodeFlagFilter传入，以NodeFlagFilter为准 示例值： -99 |
| NodeFlagFilter | 否 | 否 | String | 节点过滤标识,master core task common router all，默认为all 示例值： all |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCnt | Int64 | 满足检索条件的节点的总量 示例值： 1 |
| IpList | Array of NodeArrCommon | 节点Ip列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：查看 |
| AliasInfo | String | 集群所有节点的别名序列化 示例值： 1 |
| SupportNodeFlagFilterList | Array of String | 支持的FlagNode列表 注意：此字段可能返回 null，表示取不到有效值。 示例值： 1 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.InvalidAppId | 无效参数，AppId。 |
| InternalError.WoodServerError | 内部服务调用异常。 |
| InternalError | 内部错误。 |
| ResourceInUse.InstanceInProcess | 实例在流程中。 |
| ResourceNotFound.ClusterNotFound | 无法找到该实例。 |
| ResourceNotFound.ServiceGroupNotFound | 无法找到该服务组件。 |
| ResourceNotFound.InstanceNotFound | 无法找到该实例。 |
| FailedOperation | 操作失败。 |