-
响应示例 返回状态码为200：批量查询DfsGroup结果 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"data" : [
{
"id" : "d25de9be-1d9a-4d06-a519-09ff92fee050",
"name" : "dfs-group-name-1",
"siteName" : "site-name-1",
"members" : [
{
"id" : "as25fdbf-8dee-4823-bac2-5bfe8e3359cb",
"status" : 0,
"name" : "devicename-1",
"esn" : "21500102390000009990",
"deviceModel" : "S6730-H28X6CZ-V2",
"peerLinkIfName" : "Eth-trunk1"
}
],
"peerLinkStatus" : 1,
"status" : 1,
"physicalLinkId" : "e9bed25d-1d9a-4d06-a519-09ff92fee050"
}
],
"totalCount" : ""
} 返回状态码为400：参数错误 HTTP/1.1 400 Bad Request
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为500：服务内部错误 HTTP/1.1 500 Internal Server Error
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
URI /v1/devicemgr/devices/dfs-groups 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 string 0~36个字符。 - 站点id,UUID格式,只有单站点和所有站点两种情况，为null查找所有站点 "9a79a511-94d0-4288-84ed-ab9710d2396c" keyword 否 string 0~64个字符。 - 模糊查询关键词，支持DfsGroup name的模糊查询 "dfs-group-name-1" pageIndex 否 int32 [1-10000] 1 分页查询分页索引，可选。可选择起始查询页，从1开始 10 pageSize 否 int32 [10-2500] 100 返回数据个数限制，默认值100，最大值2500 100
-
响应参数 返回状态码为200：批量查询DfsGroup结果 表2 DfsGroupsQueryResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 data ARRAY_REFERENCE 详细请参见表3。 DfsGroup数据 - totalCount int32 [0-100000] 0 总数 - 返回状态码为400：参数错误 详细信息请参见实际响应消息体。 返回状态码为500：服务内部错误 详细信息请参见实际响应消息体。
-
请求示例 HTTP的示例 GET /v1/devicemgr/devices/dfs-groups?siteId=9a79a511-94d0-4288-84ed-ab9710d2396c&keyword=dfs-group-name-1&pageIndex=10&pageSize=100 HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-AC
CES S-TOKEN: x-yyyyyy
-
请求示例 HTTP的示例 POST /v1/devicemgr/devices/dfs-groups/action/batch-create HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
{
"params" : [
{
"name" : "dfs-group-name-1",
"deviceIds" : ["as25fdbf-8dee-4823-bac2-5bfe8e3359cb","as25fdbf-8dee-4823-bac2-5bfe8e3359cd"],
"siteId" : "9a79a511-94d0-4288-84ed-ab9710d2396c"
}
]
}
-
响应示例 返回状态码为200：创建全部成功，批量创建DfsGroup结果 {
"successList" : [
{
"id" : "d25de9be-1d9a-4d06-a519-09ff92fee050",
"deviceIds" : ["as25fdbf-8dee-4823-bac2-5bfe8e3359cb","as25fdbf-8dee-4823-bac2-5bfe8e3359cd"]
}
],
"failedList" : []
} 返回状态码为207：创建部分成功，批量创建DfsGroup结果 {
"successList" : [
{
"id" : "d25de9be-1d9a-4d06-a519-09ff92fee050",
"deviceIds" : ["as25fdbf-8dee-4823-bac2-5bfe8e3359cb","as25fdbf-8dee-4823-bac2-5bfe8e3359cd"]
}
],
"failedList" : [
{
"errorCode" : "errorCode",
"errorMsg" : "errorMsg",
"name" : "dfs-group-name-1",
"deviceIds" : ["as25fdbf-8dee-4823-bac2-5bfe8e3359cb","as25fdbf-8dee-4823-bac2-5bfe8e3359cd"]
}
]
} 返回状态码为400：参数错误或者全部失败 {
"successList" : [],
"failedList" : [
{
"errorCode" : "errorCode",
"errorMsg" : "errorMsg",
"name" : "dfs-group-name-1",
"deviceIds" : ["as25fdbf-8dee-4823-bac2-5bfe8e3359cb","as25fdbf-8dee-4823-bac2-5bfe8e3359cd"]
}
]
} 返回状态码为500：服务内部错误 HTTP/1.1 500 Internal Server Error
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
响应参数 返回状态码为200：删除全部成功，DfsGroup删除结果 表3 DfsGroupBatchDeleteResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 successList ARRAY_REFERENCE 0-100个列表项，详细请参见表4。 删除成功的结果 - failedList ARRAY_REFERENCE 0-100个列表项，详细请参见表5。 删除失败的结果 - 表4 DfsGroupBatchDeleteSuccessResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 1~36个字符。 - 删除成功的DfsGroupID "d25de9be-1d9a-4d06-a519-09ff92fee050" name string 1~64个字符。 - 删除成功的DfsGroupName "dfs-group-name-1" 表5 DfsGroupBatchDeleteFailedResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode string 1~64个字符。 - 删除失败错误码 "1" errorMsg string 1~256个字符。 - 删除失败错误信息 "delete failed db error" id string 1~36个字符。 - DfsGroupID "d25de9be-1d9a-4d06-a519-09ff92fee050" name string 1~64个字符。 - 删除失败的DfsGroupName "dfs-group-name-1" 返回状态码为207：删除部分成功，DfsGroup删除结果 DfsGroupBatchDeleteResponse对象的参数列表，详细请参见表3。 返回状态码为400：参数错误或者删除全部失败 DfsGroupBatchDeleteResponse对象的参数列表，详细请参见表3。 返回状态码为500：服务内部错误 详细信息请参见实际响应消息体。
-
响应示例 返回状态码为200：删除全部成功，DfsGroup删除结果 {
"successList" : [
{
"id" : "d25de9be-1d9a-4d06-a519-09ff92fee050",
"name" : "dfs-group-name-1"
}
],
"failedList" : []
} 返回状态码为207：删除部分成功，DfsGroup删除结果 {
"successList" : [
{
"id" : "d25de9be-1d9a-4d06-a519-09ff92fee050",
"name" : "dfs-group-name-1"
}
],
"failedList" : [
{
"errorCode" : "errorCode",
"errorMsg" : "errorMsg",
"id" : "b25de9be-1d9a-4d06-a519-09ff92fee050",
"name" : "dfs-group-name-2"
}
]
} 返回状态码为400：参数错误或者删除全部失败 {
"successList" : [],
"failedList" : [
{
"errorCode" : "errorCode",
"errorMsg" : "errorMsg",
"id" : "d25de9be-1d9a-4d06-a519-09ff92fee050",
"name" : "dfs-group-name-1"
}
]
} 返回状态码为500：服务内部错误 HTTP/1.1 500 Internal Server Error
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
请求示例 HTTP的示例 POST /v1/devicemgr/devices/dfs-groups/action/batch-delete HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
{
"ids" : ["d25de9be-1d9a-4d06-a519-09ff92fee050","as25fdbf-8dee-4823-bac2-5bfe8e3359cd"]
}
