接口功能介绍
创建检测
接口约束
上海15
URI
POST /v4/cwai/diagnosis/create
路径参数
无
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 区域唯一ID | 81f7728662dd11ec810800155d307d5b |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| accountID | 否 | String | 账户ID | 54a6039b5f3c4d26945784e0b1c854af | |
| checkItemList | 否 | Array of Objects | - | checkItemList | |
| diagnosisID | 否 | Integer | 检测任务ID | 11 | |
| nodeType | 否 | String | 诊断内容：节点类型，昇腾/英伟达Nvidia/Huawei | Nvidia | |
| nodes | 否 | Array of Objects | 资源组包含的节点详情 | - | nodes |
| properties | 否 | Object | 网络测试项 | properties | |
| regionID | 是 | String | 区域ID | 81f7728662dd11ec810800155d307d5b | |
| resourceGroupID | 是 | String | 资源组ID | 5f082074-149e-41c1-a6f6-a5bd940465e5 | |
| resourceGroupName | 否 | String | 资源组名称 | test | |
| statusMsg | 否 | String | - | 检测成功 | |
| type | 否 | String | 诊断类型 | server | |
| userID | 否 | String | - | 32bb284c9b1b4256a49ecd58dd283dd1 |
表 checkItemList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| config | 否 | Array of Objects | 自定义检测项配置数组 | config | |
| name | 否 | String | 检测项名称 | MountPoint |
表 properties
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| cclModel | 否 | String | 测试内容配置：通讯模型(ccl) | reduce_test | |
| cclType | 否 | String | 测试内容配置：通讯库类别(nccl/hccl,ccl) | nccl | |
| gpuNums | 否 | Integer | 测试内容配置：单节点待测GPU数量(8,ccl) | 8 | |
| isBidirectional | 否 | Integer | 测试内容配置：测试方向(单向-0/双向-1,RDMA) | 0 | |
| isSharpe | 否 | Integer | 测试内容配置：(nccl)SHARP(1开启，0未开启)(ccl) | 0 | |
| networkType | 否 | String | 测试内容配置：网络类型(IB\RoCE,RDMA) | IB | |
| nodePasswd | 否 | String | 测试目标：节点密码(ccl,RDMA) | xx | |
| nodePort | 否 | Integer | 测试目标：节点端口(RDMA) | 9001 | |
| testType | 否 | String | 测试内容配置：测试类型(带宽/时延,RDMA)-latency, bandwidth | bandwidth |
表 nodes
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| RDMAID | 否 | String | RDMA网卡ID | mlx5_1 | |
| baseline | 否 | Boolean | 基线 | true | |
| nodeID | 是 | String | 节点ID | ss-8mg7feqbried5b5xnnqmgdeplazc | |
| nodeName | 否 | String | 节点名称 | test |
表 config
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 否 | String | 检测项子名称 | MemoryCapacity | |
| value | 否 | String | 检测项自定义配置值 | 0 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| errorCode | String | 错误代码 | Cwai.Api.xxxx | |
| message | String | 错误信息描述 | Invalid Request | |
| returnObj | String | 返回信息 | - | |
| statusCode | Integer | 状态码 | 800 |
枚举参数
无
请求示例
请求url
POST https://cwai-global.ctapi.ctyun.cn/v4/cwai/diagnosis/create
Content-Type:application/json
请求头header
regionID:81f7728662dd11ec810800155d307d5b
请求体body
{
"userID": "41bb284c9b1b4256a49ecd58dd283dd1",
"accountID": "78a6039b5f3c4d26945784e0b1c799af",
"type": "server",
"regionID": "81f7728662dd11ec810800155d307d5b",
"nodeType": "Nvidia",
"resourceGroupID": "5f082074-149e-41c1-a6f6-a5bd940465e5",
"Properties": {
},
"checkItemList": [
{
"name": "GPUDriver"
}
],
"nodes": [
{
"nodeID": "ss-8mg7feqbried5b5xnnqmgdeplazc",
"baseline": true
}
]
}
响应示例
{
"statusCode": 800,
"userID": "41bb284c9b1b4256a49ecd58dd283dd1",
"accountID": "78a6039b5f3c4d26945784e0b1c799af",
"type": "server",
"regionID": "81f7728662dd11ec810800155d307d5b",
"nodeType": "Nvidia",
"resourceGroupID": "5f082074-149e-41c1-a6f6-a5bd940465e5",
"Properties": {
"gpuNums": 8,
"isBidirectional": 0,
"isSharpe": 0,
"nodePort": 0
},
"diagnosisID": 1893
"checkItemList": [
{
"name": "GPUDriver"
}
],
"nodes": [
{
"nodeID": "ss-8mg7feqbried5b5xnnqmgdeplazc",
"nodeName": "xuyiyi"
"baseline": true
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码
