机器报告

警告:此处的 API 文档适用于 Clanforge。如果使用 Multiplay Hosting,请参阅 Multiplay Hosting API 文档

获取所提供帐户服务 ID (ASID) 下的机器列表。

https://api.multiplay.co.uk/cfp/v4/machines/views/report

方法

GET

请求参数

变量描述可选
accountServiceId<accountserviceid> 参数接受与指定资源关联的帐户服务 ID (ASID)。请求标头中的凭据必须具备 ASID 访问权限才能执行请求。
limit<limit> 参数接受整数,该整数表示要返回的结果数量。默认情况下,返回的结果数量为 100。您可以指定的最大值为 20,000。

响应字段

此终端会返回一组以下对象。

字段类型描述可选
ip字符串机器的 IP 地址
locationname字符串此机器的位置名称
machinecontractlength整型合同的初始期限,以月为单位
machineenddate字符串预计的原始合同结束日期
machineid整数机器的 ID
machinestartdate字符串预计的原始合同起始日期

请求示例

curl --location --request GET "https://api.multiplay.co.uk/cfp/v4/machines/views/report?accountServiceId=<accountserviceid>&limit=<limit>" \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'

响应示例

[
    {
        "ip": <ip>,
        "locationName": <locationname>,
        "machineContractLength": <machinecontractlength>,
        "machineEndDate": <machineenddate>,
        "machineId": <machineid>,
        "machineStartDate": <machinestartdate>
    },
    ...
]