1. 接口描述
接口请求域名: cwp.api3.fincloud.tencent.cn。
获取主机登录方式状态
默认接口请求频率限制:20次/秒。
接口更新时间:0001-01-01 00:00:00。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeMachineLoginTypeStatus |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-02-28 |
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 |
| InstanceId | 否 | 否 | String | instance_id(instance_id和quuid至少要填一个) 示例值: inst-anyinst |
| MemberId | 否 | 否 | Array of String | 集团账号的成员id 示例值: [{"mem-6wfo0fzks3","mem-85fo0fzks4"}] |
| Quuid | 否 | 否 | String | 主机quuid列表(instance_id和quuid至少要填一个) 示例值: 5a540076-d38a-4078-aa98-qwert371d322 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| LoginType | Uint64 | 登录方式:0-原始方式,1-扫码免密登录 示例值: 1 |
| ReturnCode | Uint64 | 无法启用扫码登录的原因: 0: 成功(可以扫码登录) 1: 未安装agent 2: agent离线 3: agent版本不支持 4:未知错误 示例值: 0 |
| ReturnMessage | String | 无法启用扫码登录的原因描述 示例值: Agent Offline |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| MissingParameter | 缺少参数错误。 |
| ResourceNotFound | 资源不存在。 |
| InvalidParameter | 参数错误。 |
| OperationDenied | 操作被拒绝。 |
| InvalidParameterValue | 参数取值错误。 |