开机/关机
该接口通过鉴权接口颁发的token作为访问令牌,主机开机或关机时需要确保主机是存在的,主机是否开机/关机成功需要主动查询主机信息接口获取主机状态,调用者才能知晓主机是否开机/关机成功。建议是15秒查询一次主机状态。主机状态枚举具体详情可以查看查询主机信息接口。
1.接口描述
接口请求地址:GET v1/pve/open/operate/{id}
2.输入参数
| 参数名称 | 描述 | 是否必选 | 类型 | Location |
|---|---|---|---|---|
| Finovy-Access-Token | 令牌-口令 | yes | string | header |
| id | 主机ID | yes | string | path |
| type | 0:关闭主机 1:开启主机 | yes | string | query |
3.输出参数
可查看规范说明响应公共字段
4.示例
示例1:请求成功示例
输入示例
GET https://client.xuandashi.com/v1/pve/open/operate/2dRVVRTTOJ?type=1
Finovy-Access-Token: 3V41hUWEwlwKH44m7SpJOs
<公共请求参数>
输出示例
{
"code":0,
"data":true,
"msg":"success",
"success":true,
"traceId":"xxxxxxxxxxxxxx"
}
5.错误码
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 1037 | 未进行实名认证 | 请完成实名认证 |
| 6000 | 开机中 | 请等待开机完成 |
| 6001 | 关机中 | 请等待关机完成 |
| 6002 | 资源不足, 请重新选择配置 | 请选取其他主机配置 |
| 6003 | 钱包余额不足 | 钱包余额不足 |
6.Java请求示例
import java.io.IOException;
import java.io.InputStream;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Scanner;
class Main{
public static void main(String[] args) throws IOException {
URL url = new URL("https://client.xuandashi.com/v1/pve/open/operate/2dRVVRTTOJ?type=1");
HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
httpConn.setRequestMethod("GET");
httpConn.setRequestProperty("Content-Type", "application/json");
httpConn.setRequestProperty("Finovy-Access-Token", "3V41hUWEwlwKH44m7SpJOs");
InputStream responseStream = httpConn.getResponseCode() / 100 == 2
? httpConn.getInputStream()
: httpConn.getErrorStream();
Scanner s = new Scanner(responseStream).useDelimiter("\\A");
String response = s.hasNext() ? s.next() : "";
System.out.println(response);
}
}