DescribeMachine
最近更新时间: 2025-10-20 17:05:52
1. 接口描述
接口请求域名: redis.api3.fincloud.tencent.cn。
获取机器列表
默认接口请求频率限制:20次/秒。
接口更新时间:2023-11-14 17:24:15。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeMachine |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-04-12 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 否 | 否 | String | 实例id |
| Zone | 否 | 否 | String | 分区 |
| Region | 否 | 否 | String | 地域 |
| EngineRoom | 否 | 否 | String | 引擎 |
| Grocery | 否 | 否 | String | 仓库 |
| Switcher | 否 | 否 | String | 交换机 |
| MachineType | 否 | 否 | String | 设备类型:cache/proxy |
| Remark | 否 | 否 | String | 设备备注 |
| MachineIP | 否 | 否 | String | 机器ip |
| MemorySize | 否 | 否 | Int64 | 内存大小 |
| ChassisId | 否 | 否 | String | 机架信息 |
| Limit | 否 | 否 | Int64 | 页限制大小 |
| Offset | 否 | 否 | Int64 | 偏移量 |
| PoolName | 否 | 否 | String | 资源池名称 |
| PoolArch | 否 | 否 | String | 资源池版本 |
| PoolId | 否 | 否 | String | 资源池id |
| IsOperation | 否 | 否 | Bool | IsOperation |
| ResourceId | 否 | 否 | String | ResourceId |
| InstanceIds | 否 | 否 | Array of String | 实例id |
| Token | 否 | 否 | String | Token |
| RegionId | 否 | 否 | Int64 | RegionId |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 机器总数 |
| Machines | Machines | 机器列表 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见公共错误码。