14.运维

1. 创建流量查询任务

接口地址: /v1/instance/flow/query

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*,application/json

支持版本:v1.18.0

接口描述:

创建流量查询任务，通过获取流量查询任务结果接口查询结果

请求参数:

参数名称	参数说明	位置	是否必须	数据类型	描述
instanceUuids	容器 uuid	body	true	list	单条或多条容器数据
startTime	起始时间	body	true	string	查询开始时间（必须为⼩时整点时间），格式为yyyy-MM-dd hh:mm:ss
endTime	结束时间	body	true	string	查询结束时间（必须为⼩时整点时间），格式为yyyy-MM-dd hh:mm:ss
billingType	计费类型	body	true	string	枚举类型：PEEKPERCENT95（95峰值带宽计费）
taskDesc	任务描述	body	false	string	任务描述

请求示例，实际请求请替换参数值:

POST "/openapi/v1/instance/flow/query"
body:
{
    "instanceUuids": ["i-236a0f378e9f109584d13c3591c42dff","i-39757fe1833c29fd0ef8263b8d2f46d3"],
    "startTime":"2023-09-01 18:00:00",
    "endTime":"2023-10-01 18:00:00",
    "billingType":"PEEKPERCENT95",
    "taskDesc":"2023年9月份流量汇总"
}

响应参数:

参数名称	参数说明	类型	描述
code	返回代码	integer
message	返回处理消息	string
result	返回数据对象	list<object>
jobId	任务ID	string
timestamp	时间戳	integer
traceId	请求处理ID	string

响应示例:

{
    "message": "操作成功！",
    "code": 200,
    "result": {
        "jobId": "4730ee885e6845ec8a4f026fe90e7920"
    },
    "timestamp": 1705479262853,
    "traceId": "C20240117161421507001"
}

2. 获取流量查询任务结果

接口地址: /v1/instance/flow/query/result/{jobId}

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*,application/json

支持版本:v1.18.0

接口描述:

获取流量查询任务结果

请求参数:

参数名称	参数说明	位置	是否必须	数据类型	描述
jobId	调用接口后返回的 jobId	path	true	string	任务ID

请求示例，实际请求请替换参数值:

POST "/openapi/v1/instance/flow/query/result/4730ee885e6845ec8a4f026fe90e7920"

响应参数:

参数名称	参数说明	类型	描述
code	返回代码	integer
message	返回处理消息	string
result	返回数据对象	list<object>
jobId	任务ID	string
status	任务执行状态	int	1:执行中 2:执行成功 -1:执行失败
billingType	计费类型	string	枚举类型：PEEKPERCENT95（95峰值带宽计费）
billingValue	计费值	double	成功状态时有值，带宽（单位bps）
bandwidthList	带宽明细列表	list<object>
recordTime	记录时间	long
receive	接收数据	double	单位：bps
send	发送数据	double	单位：bps
timestamp	时间戳	integer
traceId	请求处理ID	string

响应示例:

{
    "message": "操作成功！",
    "code": 200,
    "result": {
        "jobId": "4730ee885e6845ec8a4f026fe90e7920",
        "taskDesc":"2023年9月份流量汇总",
        "status":2,
        "billingType":"PEEKPERCENT95",
        "billingValue":100.0,
        "bandwidthList":[{
            "recordTime":1676020200000,
            "receive":50.0,
            "send":50.0
        }]
    },
    "timestamp": 1705479262853,
    "traceId": "C20240117161421507001"
}

3. 查询服务器在线状态

接口地址: /v1/arm/server/query/online/status

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*,application/json

支持版本:v1.19.0

接口描述:

查询服务器在线状态

请求参数:

参数名称	参数说明	位置	是否必须	数据类型	描述
nodeUuid	节点uuid	body	true	string
armServerUuids	服务器uuid列表	body	true	list

请求示例，实际请求请替换参数值:

POST "/openapi/v1/arm/server/query/online/status"
body:
{
    "armServerUuids":["s-08f5fb859a9d9161c2727bf57e586f02"],
    "nodeUuid":"81f62329436eed8f36d0595bf81b63db"
}

响应参数:

参数名称	参数说明	类型	描述
code	返回代码	integer
message	返回处理消息	string
result	返回数据对象	object
serverList	键值对	object	key为uuid，value为状态（1:在线；0:离线）
timestamp	时间戳	integer
traceId	请求处理ID	string

响应示例:

{
    "message": "操作成功",
    "code": 200,
    "result": {
        "serverList": {
            "s-08f5fb859a9d9161c2727bf57e586f02": 1
        }
    },
    "timestamp": 1736495691785,
    "traceId": "E20250110155451785129"
}

4. 查询板卡在线状态

接口地址: /v1/arm/card/query/online/status

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*,application/json

支持版本:v1.19.0

接口描述:

查询板卡在线状态

请求参数:

参数名称	参数说明	位置	是否必须	数据类型	描述
nodeUuid	节点uuid	body	true	string
uuids	板卡uuid列表	body	true	list

请求示例，实际请求请替换参数值:

POST "/v1/arm/card/query/online/status"
body:
{
    "uuids":["26d9132fdfe8fe58e52ea13033239ac3","8398e402e6bd85c7e27f15f088d8d9e2"],
    "nodeUuid":"81f62329436eed8f36d0595bf81b63db"
}

响应参数:

参数名称	参数说明	类型	描述
code	返回代码	integer
message	返回处理消息	string
result	返回数据对象	object
armCardList	键值对	object	key为uuid，value为状态（1:在线；0:离线）
timestamp	时间戳	integer
traceId	请求处理ID	string

响应示例:

{
    "message": "操作成功",
    "code": 200,
    "result": {
        "armCardList": {
            "8398e402e6bd85c7e27f15f088d8d9e2": 1,
            "26d9132fdfe8fe58e52ea13033239ac3": 1
        }
    },
    "timestamp": 1736496285388,
    "traceId": "E20250110160445388133"
}

5. 查询板卡资源使用

接口地址: /v1/system/resource/current

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*,application/json

支持版本:v1.19.0

接口描述:

查询板卡的cpu、内存和磁盘资源使用情况

请求参数:

参数名称	参数说明	位置	是否必须	数据类型	描述
snList	板卡sn列表	body	true	list	若传uuids的值，则snList不传，两个参数只传其中一个
uuids	板卡uuid列表	body	true	list	若传snList的值，则uuids不传，两个参数只传其中一个
type	类型	body	true	integer	1:板卡。目前只支持板卡类型

请求示例，实际请求请替换参数值:

POST "/v1/system/resource/current"
body:
{
    "type": 1,
    "snList": [
        "OR65M62QC2D242406618"
    ]
}

响应参数:

参数名称	参数说明	类型	描述
code	返回代码	integer
message	返回处理消息	string
result	返回数据对象	object
list	数据对象	object
sn或uuid	sn或uuid	string
recordTime	时间戳(秒)	long	采集的时间点
cpuCore	cpu总核数	string
cpuUsageActive	cpu使用率	string
memTotal	总内存	string
memAvailable	可用内存	string
memActualUsed	实际使用内存	string
memUsedPercent	内存使用率	string
diskTotal	总磁盘	string
diskUsed	磁盘使用量	string
diskUsedPercent	磁盘使用率	string
timestamp	时间戳	integer
traceId	请求处理ID	string

响应示例:

{
    "code": 200,
    "result": {
        "list": {
            "OR65Q61QC2D240402603": {
                "cpuCore": "8",
                "cpuUsageActive": "3.52%",
                "diskTotal": "223.59G",
                "diskUsed": "11.60G",
                "diskUsedPercent": "5.19%",
                "memActualUsed": "2.58G",
                "memAvailable": "8.89G",
                "memTotal": "11.47G",
                "memUsedPercent": "22.49%",
                "recordTime": 1755225150
            },
            "OR65Q61QC2D240403791": {
                "cpuCore": "8",
                "cpuUsageActive": "3.59%",
                "diskTotal": "223.59G",
                "diskUsed": "10.95G",
                "diskUsedPercent": "4.90%",
                "memActualUsed": "2.58G",
                "memAvailable": "8.88G",
                "memTotal": "11.47G",
                "memUsedPercent": "22.52%",
                "recordTime": 1755225150
            }
        }
    },
    "success": true,
    "timestamp": 0
}

6. 回收板卡（原退订板卡）

接口地址: /v1/arm/card/apply/release

请求方式: POST

请求数据类型: application/json

响应数据类型: */*,application/json

支持版本: v1.18.0

callbackUrl 由 v1.19.0 版本提供

接口描述:

回收板卡（原退订板卡，后期计划仅管理员使用接口，会增加权限管控）

请求参数:

参数名称	参数说明	位置	是否必须	数据类型	描述
nodeUuid	节点 uuid	body	true	string
batchMap	板卡uuid/板卡名称 键值对	body	false	object	计划后期下线此字段，推荐传uuids字段的值替代此字段
uuids	板卡uuid列表	body	true	List<String>	替代batchMap
deepRelease	深度回收	body	false	boolean	释放板卡后有回收任务。 当值为true时，回收任务流程：销毁板卡容器->自动qfile刷机->重新绑定板卡ip->安装最新cce、ccem； 当值为false时，回收任务流程：销毁板卡容器
callbackUrl	通知回调地址	body	false	string	POST请求

请求示例

POST "/openapi/v1/arm/card/apply/release"
body:
{
    "batchMap":{
        "e123de61c90d0abbd503c48c769bb38a":"fjz-api-1"
    },
    "uuids": ["e123de61c90d0abbd503c48c769bb38a"],
    "nodeUuid":"81f62329436eed8f36d0595bf81b63db",
    "deepRelease": true,
    "callbackUrl": "http://127.0.0.1/notice"
}

响应参数:

参数名称	参数说明	类型	描述
code	返回代码	integer(int32)
message	返回处理消息	string
result	返回数据对象	object
recycleJobs	回收任务结果	list<object>
jobId	任务id	string	板卡回收任务id ，查询任务详情用此 jobId
code	任务提交状态码	integer	对应响应状态码表
message	任务提交描述	string
uuid	板卡 uuid	string
sn	板卡 SN	string
recycleTraceId	回收任务业务ID	string
jobs	任务结果	list<object>
jobId	任务id	string
code	任务提交状态码	integer	对应响应状态码表
message	任务提交描述	string
uuid	板卡 uuid	string
sn	板卡 SN	string
timestamp	时间戳	integer(int64)
traceId	请求处理ID	string

响应示例:

{
    "message": "操作成功",
    "code": 200,
    "result": {
        "recycleJobs": [
            {
                "jobId": "4431f0758c244106950b1a98f358d433",
                "code": 200,
                "sn": "OR65Q61QC2D240403252",
                "recycleTraceId": "E20250326183529385229_1",
                "message": "success",
                "uuid": "ef8f33d103ffc9b79af8709397e3d559"
            }
        ],
        "jobs": [
            {
                "jobId": "c5ebec444805454c97f8884804796dde",
                "code": 200,
                "sn": "OR65Q61QC2D240403252",
                "message": "success",
                "uuid": "ef8f33d103ffc9b79af8709397e3d559"
            }
        ]
    },
    "timestamp": 1742985329522,
    "traceId": "E20250326183529385229"
}