你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Operations
获取群集节点
GET /clusters/{cluster}/nodes
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
路径 | cluster (必需) |
要查询的群集 | 字符串 |
查询 | operation (可选) |
如果给定,则仅返回此操作 ID 的节点,并在正文中包含操作属性 | 字符串 |
查询 | request_id (可选) |
如果给定,则仅返回此请求 ID 标识的操作的节点, 和 包括正文上的操作属性 |
string |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
200 | OK | NodeList |
400 | 规范无效 | 无内容 |
404 | 未找到 | 无内容 |
示例 HTTP 请求
请求路径
/clusters/CLUSTER_NAME/nodes
示例 HTTP 响应
响应 200
{
"nodes" : [ { } ],
"operation" : {
"action" : "string",
"startTime" : "2020-01-01T12:34:56Z"
}
}
创建群集节点
POST /clusters/{cluster}/nodes/create
说明
此操作将 nodearray 中的新节点添加到群集。 它接受单个调用中的多个节点定义。 它返回可用于跟踪操作状态的操作的 URL。
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
路径 | cluster (必需) |
要向其添加节点的群集 | 字符串 |
正文 | 节点 (必需) |
要创建的节点集 | NodeCreationRequest |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
202 | 已接受 标头 : Location (字符串) :操作的 URL。 |
NodeCreationResult |
409 | 无效输入 | 无内容 |
示例 HTTP 请求
请求路径
/clusters/CLUSTER_NAME/nodes/create
请求正文
{
"requestId" : "00000000-0000-0000-0000-000000000000",
"sets" : [ "object" ]
}
示例 HTTP 响应
响应 202
{
"operationId" : "00000000-0000-0000-0000-000000000000",
"sets" : [ "object" ]
}
解除分配群集节点
POST /clusters/{cluster}/nodes/deallocate
说明
此操作可解除分配群集中的节点。 可以通过多种方式(包括节点名称、节点 ID 或筛选器)来标识节点。
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
路径 | cluster (必需) |
要解除分配节点的群集 | 字符串 |
正文 | action (必需) |
说明要解除分配的节点 | NodeManagementRequest |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
202 | 已接受 标头 : Location (字符串) :操作的 URL。 |
NodeManagementResult |
409 | 无效输入 | 无内容 |
示例 HTTP 请求
请求路径
/clusters/CLUSTER_NAME/nodes/deallocate
请求正文
{
"filter" : "State === \"Started\"",
"hostnames" : [ "hostname1", "hostname2" ],
"ids" : [ "id1", "id2" ],
"ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
"names" : [ "name1", "name2" ],
"requestId" : "00000000-0000-0000-0000-000000000000"
}
示例 HTTP 响应
响应 202
{
"nodes" : [ "object" ],
"operationId" : "00000000-0000-0000-0000-000000000000"
}
终止和删除群集节点
POST /clusters/{cluster}/nodes/remove
说明
此操作会删除群集中的节点。 可以通过多种方式(包括节点名称、节点 ID 或筛选器)来标识节点。 请注意,默认情况下,节点在终止 (时会删除,除非节点已将 Fixed 设置为 true) ,在这种情况下,此调用与终止没有不同。
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
路径 | cluster (必需) |
要删除节点的群集 | 字符串 |
正文 | action (必需) |
要删除的节点的说明 | NodeManagementRequest |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
202 | 已接受 标头 : Location (字符串) :操作的 URL。 |
NodeManagementResult |
409 | 无效输入 | 无内容 |
示例 HTTP 请求
请求路径
/clusters/CLUSTER_NAME/nodes/remove
请求正文
{
"filter" : "State === \"Started\"",
"hostnames" : [ "hostname1", "hostname2" ],
"ids" : [ "id1", "id2" ],
"ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
"names" : [ "name1", "name2" ],
"requestId" : "00000000-0000-0000-0000-000000000000"
}
示例 HTTP 响应
响应 202
{
"nodes" : [ "object" ],
"operationId" : "00000000-0000-0000-0000-000000000000"
}
终止或解除分配群集节点
POST /clusters/{cluster}/nodes/shutdown
说明
此操作终止或解除分配群集中的节点,具体取决于每个节点上的 ShutdownPolicy 属性是分别 (默认) 还是 Deallocate。
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
路径 | cluster (必需) |
要关闭节点的群集 | 字符串 |
正文 | action (必需) |
说明要关闭的节点 | NodeManagementRequest |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
202 | 已接受 标头 : Location (字符串) :操作的 URL。 |
NodeManagementResult |
409 | 无效输入 | 无内容 |
示例 HTTP 请求
请求路径
/clusters/CLUSTER_NAME/nodes/shutdown
请求正文
{
"filter" : "State === \"Started\"",
"hostnames" : [ "hostname1", "hostname2" ],
"ids" : [ "id1", "id2" ],
"ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
"names" : [ "name1", "name2" ],
"requestId" : "00000000-0000-0000-0000-000000000000"
}
示例 HTTP 响应
响应 202
{
"nodes" : [ "object" ],
"operationId" : "00000000-0000-0000-0000-000000000000"
}
启动已解除分配或终止的群集节点
POST /clusters/{cluster}/nodes/start
说明
此操作启动群集中的节点。 可以通过多种方式(包括节点名称、节点 ID 或筛选器)来标识节点。
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
路径 | cluster (必需) |
要启动节点的群集 | 字符串 |
正文 | action (必需) |
要启动的节点的说明 | NodeManagementRequest |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
202 | 已接受 标头 : Location (字符串) :操作的 URL。 |
NodeManagementResult |
409 | 无效输入 | 无内容 |
示例 HTTP 请求
请求路径
/clusters/CLUSTER_NAME/nodes/start
请求正文
{
"filter" : "State === \"Started\"",
"hostnames" : [ "hostname1", "hostname2" ],
"ids" : [ "id1", "id2" ],
"ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
"names" : [ "name1", "name2" ],
"requestId" : "00000000-0000-0000-0000-000000000000"
}
示例 HTTP 响应
响应 202
{
"nodes" : [ "object" ],
"operationId" : "00000000-0000-0000-0000-000000000000"
}
终止群集节点
POST /clusters/{cluster}/nodes/terminate
说明
此操作将终止群集中的节点。 可以通过多种方式(包括节点名称、节点 ID 或筛选器)来标识节点。
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
路径 | cluster (必需) |
要终止节点的群集 | 字符串 |
正文 | action (必需) |
要终止的节点的说明 | NodeManagementRequest |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
202 | 已接受 标头 : Location (字符串) :操作的 URL。 |
NodeManagementResult |
409 | 无效输入 | 无内容 |
示例 HTTP 请求
请求路径
/clusters/CLUSTER_NAME/nodes/terminate
请求正文
{
"filter" : "State === \"Started\"",
"hostnames" : [ "hostname1", "hostname2" ],
"ids" : [ "id1", "id2" ],
"ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
"names" : [ "name1", "name2" ],
"requestId" : "00000000-0000-0000-0000-000000000000"
}
示例 HTTP 响应
响应 202
{
"nodes" : [ "object" ],
"operationId" : "00000000-0000-0000-0000-000000000000"
}
根据大小缩放群集
POST /clusters/{cluster}/scale/{nodearray}
说明
此操作根据需要将节点添加到 nodearray 中,以达到总计数。 请求将处理一次,以后不会重新添加节点来维护给定的数量。 这会按总核心数或总节点数进行缩放,但不能同时按两者进行缩放。 它返回可用于跟踪操作状态的操作的 URL。
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
路径 | cluster (必需) |
要向其添加节点的群集 | 字符串 |
路径 | nodearray (必需) |
要向其添加节点的 nodearray | 字符串 |
查询 | totalCoreCount (可选) |
此 nodearray 中要包含的核心总数,包括已创建的节点 | 整型 |
查询 | totalNodeCount (可选) |
此 nodearray 中要包含的计算机总数,包括已创建的节点 | integer |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
202 | 已接受 标头 : Location (字符串) :操作的 URL。 |
NodeCreationResult |
409 | 无效输入 | 无内容 |
示例 HTTP 请求
请求路径
/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME
示例 HTTP 响应
响应 202
{
"operationId" : "00000000-0000-0000-0000-000000000000",
"sets" : [ "object" ]
}
获取群集状态
GET /clusters/{cluster}/status
说明
此操作包含给定群集中的节点和节点数组的信息。 对于每个 nodearray,它将返回可以使用的每个分配“存储桶”的状态,例如存储桶中有多少个节点、可以添加多少节点等。每个存储桶是给定硬件配置文件的一组可能的 VM,可以在给定位置、给定客户帐户下创建,等等。nodearray 的有效存储桶由用户的群集定义确定,但限制部分由云提供商确定。
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
路径 | cluster (必需) |
要查询的群集 | 字符串 |
查询 | 节点 (可选) |
如果为 true,则响应中返回节点和节点引用 | boolean |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
200 | OK | ClusterStatus |
示例 HTTP 请求
请求路径
/clusters/CLUSTER_NAME/status
示例 HTTP 响应
响应 200
{
"maxCoreCount" : 16,
"maxCount" : 4,
"nodearrays" : [ "object" ],
"nodes" : [ { } ],
"state" : "Starting",
"targetState" : "Started"
}
Lists操作的状态
GET /operations/
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
查询 | request_id (可选) |
操作的请求 ID。 如果已给定,列表中将只有 0 或 1 个元素。 | string |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
200 | OK | <OperationStatus> 阵 列 |
400 | 请求无效 | 无内容 |
404 | 未找到 | 无内容 |
示例 HTTP 请求
请求路径
/operations/
示例 HTTP 响应
响应 200
[ {
"action" : "string",
"startTime" : "2020-01-01T12:34:56Z"
} ]
按 ID 获取操作状态
GET /operations/{id}
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
路径 | id (必需) |
操作 ID | string |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
200 | OK | OperationStatus |
404 | 未找到 | 无内容 |
示例 HTTP 请求
请求路径
/operations/00000000-0000-0000-0000-000000000000
示例 HTTP 响应
响应 200
{
"action" : "string",
"startTime" : "2020-01-01T12:34:56Z"
}
获取群集节点
GET /clusters/{cluster}/nodes
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
路径 | cluster (必需) |
要查询的群集 | 字符串 |
查询 | operation (可选) |
如果给定,则仅返回此操作 ID 的节点,并在正文中包含操作属性 | 字符串 |
查询 | request_id (可选) |
如果给定,则仅返回此请求 ID 标识的操作的节点, 和 包括正文上的操作属性 |
string |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
200 | OK | NodeList |
400 | 规范无效 | 无内容 |
404 | 未找到 | 无内容 |
示例 HTTP 请求
请求路径
/clusters/CLUSTER_NAME/nodes
示例 HTTP 响应
响应 200
{
"nodes" : [ { } ],
"operation" : {
"action" : "string",
"startTime" : "2020-01-01T12:34:56Z"
}
}
创建群集节点
POST /clusters/{cluster}/nodes/create
说明
此操作将 nodearray 中的新节点添加到群集。 它接受单个调用中的多个节点定义。 它返回可用于跟踪操作状态的操作的 URL。
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
路径 | cluster (必需) |
要向其添加节点的群集 | 字符串 |
正文 | 节点 (必需) |
要创建的节点集 | NodeCreationRequest |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
202 | 已接受 标头 : Location (字符串) :操作的 URL。 |
NodeCreationResult |
409 | 无效输入 | 无内容 |
示例 HTTP 请求
请求路径
/clusters/CLUSTER_NAME/nodes/create
请求正文
{
"requestId" : "00000000-0000-0000-0000-000000000000",
"sets" : [ "object" ]
}
示例 HTTP 响应
响应 202
{
"operationId" : "00000000-0000-0000-0000-000000000000",
"sets" : [ "object" ]
}
解除分配群集节点
POST /clusters/{cluster}/nodes/deallocate
说明
此操作可解除分配群集中的节点。 可以通过多种方式(包括节点名称、节点 ID 或筛选器)来标识节点。
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
路径 | cluster (必需) |
要解除分配节点的群集 | 字符串 |
正文 | action (必需) |
说明要解除分配的节点 | NodeManagementRequest |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
202 | 已接受 标头 : Location (字符串) :操作的 URL。 |
NodeManagementResult |
409 | 无效输入 | 无内容 |
示例 HTTP 请求
请求路径
/clusters/CLUSTER_NAME/nodes/deallocate
请求正文
{
"filter" : "State === \"Started\"",
"hostnames" : [ "hostname1", "hostname2" ],
"ids" : [ "id1", "id2" ],
"ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
"names" : [ "name1", "name2" ],
"requestId" : "00000000-0000-0000-0000-000000000000"
}
示例 HTTP 响应
响应 202
{
"nodes" : [ "object" ],
"operationId" : "00000000-0000-0000-0000-000000000000"
}
终止和删除群集节点
POST /clusters/{cluster}/nodes/remove
说明
此操作会删除群集中的节点。 可以通过多种方式(包括节点名称、节点 ID 或筛选器)来标识节点。 请注意,默认情况下,节点在终止 (时会删除,除非节点已将 Fixed 设置为 true) ,在这种情况下,此调用与终止没有不同。
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
路径 | cluster (必需) |
要删除节点的群集 | 字符串 |
正文 | action (必需) |
要删除的节点的说明 | NodeManagementRequest |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
202 | 已接受 标头 : Location (字符串) :操作的 URL。 |
NodeManagementResult |
409 | 无效输入 | 无内容 |
示例 HTTP 请求
请求路径
/clusters/CLUSTER_NAME/nodes/remove
请求正文
{
"filter" : "State === \"Started\"",
"hostnames" : [ "hostname1", "hostname2" ],
"ids" : [ "id1", "id2" ],
"ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
"names" : [ "name1", "name2" ],
"requestId" : "00000000-0000-0000-0000-000000000000"
}
示例 HTTP 响应
响应 202
{
"nodes" : [ "object" ],
"operationId" : "00000000-0000-0000-0000-000000000000"
}
终止或解除分配群集节点
POST /clusters/{cluster}/nodes/shutdown
说明
此操作终止或解除分配群集中的节点,具体取决于每个节点上的 ShutdownPolicy 属性是分别 (默认) 还是 Deallocate。
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
路径 | cluster (必需) |
要关闭节点的群集 | 字符串 |
正文 | action (必需) |
说明要关闭的节点 | NodeManagementRequest |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
202 | 已接受 标头 : Location (字符串) :操作的 URL。 |
NodeManagementResult |
409 | 无效输入 | 无内容 |
示例 HTTP 请求
请求路径
/clusters/CLUSTER_NAME/nodes/shutdown
请求正文
{
"filter" : "State === \"Started\"",
"hostnames" : [ "hostname1", "hostname2" ],
"ids" : [ "id1", "id2" ],
"ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
"names" : [ "name1", "name2" ],
"requestId" : "00000000-0000-0000-0000-000000000000"
}
示例 HTTP 响应
响应 202
{
"nodes" : [ "object" ],
"operationId" : "00000000-0000-0000-0000-000000000000"
}
启动已解除分配或终止的群集节点
POST /clusters/{cluster}/nodes/start
说明
此操作启动群集中的节点。 可以通过多种方式(包括节点名称、节点 ID 或筛选器)来标识节点。
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
路径 | cluster (必需) |
要启动节点的群集 | 字符串 |
正文 | action (必需) |
要启动的节点的说明 | NodeManagementRequest |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
202 | 已接受 标头 : Location (字符串) :操作的 URL。 |
NodeManagementResult |
409 | 无效输入 | 无内容 |
示例 HTTP 请求
请求路径
/clusters/CLUSTER_NAME/nodes/start
请求正文
{
"filter" : "State === \"Started\"",
"hostnames" : [ "hostname1", "hostname2" ],
"ids" : [ "id1", "id2" ],
"ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
"names" : [ "name1", "name2" ],
"requestId" : "00000000-0000-0000-0000-000000000000"
}
示例 HTTP 响应
响应 202
{
"nodes" : [ "object" ],
"operationId" : "00000000-0000-0000-0000-000000000000"
}
终止群集节点
POST /clusters/{cluster}/nodes/terminate
说明
此操作将终止群集中的节点。 可以通过多种方式来标识节点,包括节点名称、节点 ID 或筛选器。
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
路径 | cluster (必需) |
要终止节点的群集 | 字符串 |
正文 | action (必需) |
要终止的节点的说明 | NodeManagementRequest |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
202 | 已接受 标头 : Location (字符串) :操作的 URL。 |
NodeManagementResult |
409 | 无效输入 | 无内容 |
示例 HTTP 请求
请求路径
/clusters/CLUSTER_NAME/nodes/terminate
请求正文
{
"filter" : "State === \"Started\"",
"hostnames" : [ "hostname1", "hostname2" ],
"ids" : [ "id1", "id2" ],
"ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
"names" : [ "name1", "name2" ],
"requestId" : "00000000-0000-0000-0000-000000000000"
}
示例 HTTP 响应
响应 202
{
"nodes" : [ "object" ],
"operationId" : "00000000-0000-0000-0000-000000000000"
}
根据大小缩放群集
POST /clusters/{cluster}/scale/{nodearray}
说明
此操作根据需要将节点添加到节点数组,以达到总计数。 请求处理一次,以后不会重新添加节点来维护给定的数量。 这会按总核心数或总节点数缩放,但不能同时缩放两者。 它将返回可用于跟踪操作状态的操作的 URL。
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
路径 | cluster (必需) |
要向其添加节点的群集 | 字符串 |
路径 | nodearray (必需) |
要向其添加节点的 nodearray | 字符串 |
查询 | totalCoreCount (可选) |
此节点数组中要具有的核心总数,包括已创建的节点 | 整型 |
查询 | totalNodeCount (可选) |
此 nodearray 中要具有的计算机总数,包括已创建的节点 | integer |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
202 | 已接受 标头 : Location (字符串) :操作的 URL。 |
NodeCreationResult |
409 | 无效输入 | 无内容 |
示例 HTTP 请求
请求路径
/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME
示例 HTTP 响应
响应 202
{
"operationId" : "00000000-0000-0000-0000-000000000000",
"sets" : [ "object" ]
}
获取群集状态
GET /clusters/{cluster}/status
说明
此操作包含给定群集中的节点和节点数组的信息。 对于每个 nodearray,它将返回可以使用的每个分配“存储桶”的状态,例如存储桶中有多少个节点、可以添加多少节点等。每个存储桶是给定硬件配置文件的一组可能的 VM,可以在给定位置、给定客户帐户下创建,等等。nodearray 的有效存储桶由用户的群集定义确定,但限制部分由云提供商确定。
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
路径 | cluster (必需) |
要查询的群集 | 字符串 |
查询 | 节点 (可选) |
如果为 true,则响应中返回节点和节点引用 | boolean |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
200 | OK | ClusterStatus |
示例 HTTP 请求
请求路径
/clusters/CLUSTER_NAME/status
示例 HTTP 响应
响应 200
{
"maxCoreCount" : 16,
"maxCount" : 4,
"nodearrays" : [ "object" ],
"nodes" : [ { } ],
"state" : "Starting",
"targetState" : "Started"
}
获取群集的使用情况和可选成本信息
GET /clusters/{cluster}/usage
说明
此操作返回群集的总体使用情况数据 (核心小时数) 和成本数据(如果可用),以及每个节点的数组明细。 默认情况下,它返回当月的使用量。
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
路径 | cluster (必需) |
要返回其使用情况数据的群集 | 字符串 |
查询 | timeframe (可选) |
如果给定,则指定用于查询的时间范围。 monthToDate 返回当前月份的使用情况,lastMonth 返回上个月的使用情况。 weekToDate 返回从星期日) 开始 (本周的使用情况。 custom 需要“from”和“to”查询参数。 默认值为 MonthToDate。 所有时间均是 UTC 时间。 | enum (monthToDate、lastMonth、weekToDate、custom) |
查询 | from (可选) |
对于自定义时间范围,这是 ISO-8601 格式的时间范围开始。 这向下舍入到最接近的小时或一天。 | 字符串 |
查询 | to (可选) |
对于自定义时间范围,这是 ISO-8601 格式的时间范围结束。 这四舍五入到最接近的小时或一天。 | 字符串 |
查询 | 粒 度 (可选) |
指定如何聚合数据:按小时、按每日或以单个数字的形式聚合数据。 此默认值为每日。 | 枚举 (总计、每日、每小时) |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
200 | OK | ClusterUsage |
示例 HTTP 请求
请求路径
/clusters/CLUSTER_NAME/usage
示例 HTTP 响应
响应 200
{
"usage" : [ "object" ]
}
Lists操作的状态
GET /operations/
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
查询 | request_id (可选) |
操作的请求 ID。 如果已给定,列表中将只有 0 或 1 个元素。 | string |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
200 | OK | <OperationStatus> 阵 列 |
400 | 请求无效 | 无内容 |
404 | 未找到 | 无内容 |
示例 HTTP 请求
请求路径
/operations/
示例 HTTP 响应
响应 200
[ {
"action" : "string",
"startTime" : "2020-01-01T12:34:56Z"
} ]
按 ID 获取操作状态
GET /operations/{id}
参数
类型 | 名称 | 说明 | 架构 |
---|---|---|---|
路径 | id (必需) |
操作 ID | string |
响应
HTTP 代码 | 说明 | 架构 |
---|---|---|
200 | OK | OperationStatus |
404 | 未找到 | 无内容 |
示例 HTTP 请求
请求路径
/operations/00000000-0000-0000-0000-000000000000
示例 HTTP 响应
响应 200
{
"action" : "string",
"startTime" : "2020-01-01T12:34:56Z"
}
资源
ClusterStatus
群集的状态
名称 | 说明 | 架构 |
---|---|---|
maxCoreCount (必需) |
可添加到此群集的最大核心数 示例 : 16 |
整型 |
maxCount (必需) |
可添加到此群集的最大节点数 示例 : 4 |
整型 |
nodearrays (必需) |
示例 : [ "object" ] |
<nodearrays> 阵 列 |
节点 (可选) |
此群集中节点的可选列表,仅当 nodes=true 在查询中时才包含 示例 : [ "[node](#node)" ] |
<节点> 阵 列 |
State (可选) |
群集的当前状态(如果已启动至少一次) 示例 : "Starting" |
字符串 |
targetState (可选) |
群集的所需状态 (例如“已启动”或“已终止”) 示例 : "Started" |
字符串 |
名称 | 说明 | 架构 |
---|---|---|
桶 (必需) |
此 nodearray 的每个分配桶。 “核心计数”设置始终是此存储桶核心计数的倍数。 示例 : [ "object" ] |
<桶> 阵 列 |
maxCoreCount (必需) |
此 nodearray 中可能的最大核心数 示例 : 16 |
整型 |
maxCount (必需) |
此节点数组中可能的最大节点数 示例 : 4 |
整型 |
name (必需) |
此描述的节点数组 示例 : "execute" |
字符串 |
nodearray (必需) |
此 nodearray 的属性 示例 : "[node](#node)" |
Node |
名称 | 说明 | 架构 |
---|---|---|
activeCoreCount (必需) |
此 nodearray 中用于此存储桶的核心数 示例 : 40 |
整型 |
activeCount (必需) |
此 nodearray 中用于此存储桶的节点数。 这包括仍在获取 VM 的节点。 示例 : 10 |
整型 |
activeNodes (可选) |
此 nodearray 中用于此存储桶的节点名称。 这包括仍在获取 VM 的节点。 仅当 nodes=true 在查询中时,才会包含此值。 示例 : [ "string" ] |
< 字符串 > 数组 |
availableCoreCount (必需) |
在此 nodearray 中,此存储桶中可以创建多少个额外核心。 始终为 availableCount 的倍数。 示例 : 8 |
整型 |
availableCount (必需) |
在此节点数组中,可以在此存储桶中创建多少个额外的节点。 请注意,这可能小于 maxCount 和 usedCount 所暗示的,因为 maxCount 可能受到全局限制。 示例 : 2 |
整型 |
bucketId (必需) |
此存储桶的标识符。 对于 nodearray 中给定的存储桶,只要未删除群集,该值将始终具有相同的值。 示例 : "00000000-0000-0000-0000-000000000000" |
字符串 |
consumedCoreCount (必需) |
此系列已在整个区域中使用的核心数。 示例 : 2 |
整型 |
definition (可选) |
此存储桶的属性,用于从此存储桶创建节点。 create-nodes API 在其 bucket 属性中采用此定义。 示例 : "object" |
definition |
familyConsumedCoreCount (可选) |
此系列已在整个区域中使用的核心数。 示例 : 2 |
整型 |
familyQuotaCoreCount (可选) |
可在此区域中为此系列启动的内核总数。 这可能不是 quotaCount 的整数倍数。 示例 : 16 |
整型 |
familyQuotaCount (可选) |
给定 familyQuotaCoreCount (可以启动的总实例数) 示例 : 4 |
整型 |
invalidReason (必需) |
如果 valid 为 false,则会包含存储桶无效的原因。 目前 NotActivated 和 DisabledMachineType 是唯一的原因。 示例 : "DisabledMachineType" |
字符串 |
maxCoreCount (必需) |
此存储桶中可能的最大核心数,包括全局和 nodearray 限制。 始终是 maxCount 的倍数。 示例 : 16 |
整型 |
maxCount (必需) |
此存储桶中可能的最大节点数,包括全局和 nodearray 限制 示例 : 4 |
整型 |
maxPlacementGroupCoreSize (必需) |
此存储桶中放置组中可包含的最大核心总数。 始终是 maxPlacementGroupSize 的倍数。 示例 : 64 |
整型 |
maxPlacementGroupSize (必需) |
此存储桶中可位于放置组中的最大实例总数 示例 : 16 |
整型 |
placementGroups (必需) |
用于此 nodearray 的放置组(如果有)。 示例 : [ "object" ] |
<placementGroups> 阵 列 |
quotaCoreCount (必需) |
可在此区域中为此系列启动的内核总数,同时考虑区域配额核心计数。 这可能不是 quotaCount 的整数倍数。 示例 : 16 |
整型 |
quotaCount (必需) |
给定 quotaCoreCount (可以启动的总实例数) 示例 : 4 |
整型 |
regionalConsumedCoreCount (可选) |
已在整个区域中使用的核心数。 示例 : 2 |
整型 |
regionalQuotaCoreCount (可选) |
可在此区域中启动的内核总数。 这可能不是 regionalQuotaCount 的整数倍数。 示例 : 16 |
整型 |
regionalQuotaCount (可选) |
给定 regionalQuotaCoreCount (可以启动的总实例数) 示例 : 4 |
整型 |
valid (必需) |
如果为 true,则此存储桶表示当前用于新节点的有效存储桶。 如果为 false,则此存储桶仅表示现有节点。 示例 : true |
boolean |
virtualMachine (必需) |
从此存储桶启动的虚拟机的属性 示例 : "object" |
virtualMachine |
名称 | 说明 | 架构 |
---|---|---|
machineType (必需) |
虚拟机的 VM 大小 示例 : "A2" |
字符串 |
名称 | 说明 | 架构 |
---|---|---|
activeCoreCount (必需) |
此规模集中有多少个核心 示例 : 16 |
整型 |
activeCount (必需) |
此规模集中有多少个节点 示例 : 4 |
整型 |
name (必需) |
此放置组的唯一标识符 示例 : "my-placement-group" |
字符串 |
名称 | 说明 | 架构 |
---|---|---|
gpuCount (必需) |
此计算机类型具有的 GPU 数 示例 : 2 |
整型 |
infiniband (必需) |
如果此虚拟机支持 InfiniBand 连接 示例 : true |
boolean |
memory (必需) |
此虚拟机中的 RAM(以 GB 为单位) 示例 : 7.5 |
数字 |
pcpuCount (必需) |
此计算机类型具有的物理 CPU 数 示例 : 16 |
整型 |
vcpuCount (必需) |
此计算机类型具有的虚拟 CPU 数 示例 : 32 |
整型 |
Node
节点记录
类型 : 对象
NodeCreationRequest
指定如何将节点添加到群集
名称 | 说明 | 架构 |
---|---|---|
requestId (可选) |
可选用户提供的唯一令牌,以防止出现网络通信错误时执行重复操作。 如果包含此 ID 并且与以前的请求 ID 匹配,则服务器将忽略此请求并返回 409 错误。 示例 : "00000000-0000-0000-0000-000000000000" |
字符串 |
集 (必需) |
要创建的节点定义列表。 请求必须至少包含一个集。 每个集可以指定一组不同的属性。 示例 : [ "object" ] |
<集> 阵 列 |
名称 | 说明 | 架构 |
---|---|---|
计数 (必需) |
要创建的节点数 示例 : 1 |
整型 |
definition (可选) |
要使用的存储桶的定义。 这由群集状态 API 调用提供。 如果缺少状态调用中给定的某些项,或者缺少整个 bucket 属性,则使用与给定项匹配的第一个存储桶。 示例 : "object" |
definition |
nameFormat (可选) |
如果给定,节点将使用此命名约定,而不是标准的“nodearray-%d”格式 示例 : "custom-name-%d" |
字符串 |
nameOffset (可选) |
如果给定,则与 nameFormat 一起偏移新节点的 nodeindex。 示例 : 1 |
整型 |
nodeAttributes (可选) |
要在此集中的每个节点上设置的其他属性 示例 : "[node](#node)" |
Node |
nodearray (必需) |
要从中启动节点的节点数组的名称 示例 : "execute" |
字符串 |
placementGroupId (可选) |
如果给定,groupId 值相同的节点都将在同一放置组中启动。 示例 : "string" |
字符串 |
名称 | 说明 | 架构 |
---|---|---|
machineType (可选) |
示例 : "A2" |
字符串 |
NodeCreationResult
名称 | 说明 | 架构 |
---|---|---|
operationId (必需) |
此操作的 ID 示例 : "00000000-0000-0000-0000-000000000000" |
字符串 |
集 (必需) |
集数组,顺序与请求中的顺序相同 示例 : [ "object" ] |
<集> 阵 列 |
名称 | 说明 | 架构 |
---|---|---|
添加 (必需) |
此集中已启动多少个节点 示例 : 1 |
整型 |
message (可选) |
指示为什么不能添加所有请求的节点(如果存在) 示例 : "string" |
字符串 |
NodeList
节点搜索结果
名称 | 说明 | 架构 |
---|---|---|
节点 (必需) |
返回的节点 示例 : [ "[node](#node)" ] |
<节点> 阵 列 |
operation (可选) |
如果查询包含操作 ID,则这是该操作的状态 示例 : "[operationstatus](#operationstatus)" |
OperationStatus |
NodeManagementRequest
指定如何在群集中的节点上执行操作。 可通过多种方式指定节点,如果包含多个方法,则将其视为联合。
名称 | 说明 | 架构 |
---|---|---|
filter (可选) |
与节点匹配的筛选器表达式。 请注意,表达式中的字符串必须正确引用。 示例 : "State === \"Started\"" |
字符串 |
主机 名 (可选) |
没有要管理的域) (的短主机名列表 示例 : [ "hostname1", "hostname2" ] |
< 字符串 > 数组 |
ids (可选) |
要管理的节点 ID 列表 示例 : [ "id1", "id2" ] |
< 字符串 > 数组 |
ip_addresses (可选) |
要管理的 IP 地址列表 示例 : [ "10.0.1.1", "10.1.1.2" ] |
< 字符串 > 数组 |
名称 (可选) |
要管理的节点名称列表 示例 : [ "name1", "name2" ] |
< 字符串 > 数组 |
requestId (可选) |
可选用户提供的唯一令牌,以防止在发生网络通信错误时执行重复操作。 如果包含此 ID 并且与以前的请求 ID 匹配,则服务器将忽略此请求并返回 409 错误。 示例 : "00000000-0000-0000-0000-000000000000" |
字符串 |
NodeManagementResult
名称 | 说明 | 架构 |
---|---|---|
节点 (必需) |
与管理请求中的筛选器匹配的每个节点的信息数组。 每个节点的状态指示它是否受到请求的影响。 示例 : [ "object" ] |
<节点> 阵 列 |
operationId (必需) |
此操作的 ID 示例 : "00000000-0000-0000-0000-000000000000" |
字符串 |
名称 | 说明 | 架构 |
---|---|---|
error (可选) |
如果状态为“错误”,则包含错误消息 示例 : "This node must be terminated before it can be removed" |
字符串 |
id (必需) |
节点的 ID 示例 : "id1" |
字符串 |
name (必需) |
节点的名称 示例 : "name1" |
字符串 |
status (可选) |
正常或错误之一 示例 : "Error" |
枚举 (正常,错误) |
OperationStatus
此节点操作的状态
名称 | 说明 | 架构 |
---|---|---|
action (必需) |
示例 : "string" |
枚举 (创建) |
startTime (必需) |
提交此操作时 示例 : "2020-01-01T12:34:56Z" |
字符串(日期时间) |
ClusterStatus
群集的状态
名称 | 说明 | 架构 |
---|---|---|
maxCoreCount (必需) |
可添加到此群集的最大核心数 示例 : 16 |
整型 |
maxCount (必需) |
可添加到此群集的最大节点数 示例 : 4 |
整型 |
nodearrays (必需) |
示例 : [ "object" ] |
<nodearrays> 阵 列 |
节点 (可选) |
此群集中的节点的可选列表,仅当 nodes=true 在查询中时才包含 示例 : [ "[node](#node)" ] |
<节点> 阵 列 |
State (可选) |
群集的当前状态(如果已至少启动一次) 示例 : "Starting" |
字符串 |
targetState (可选) |
群集的所需状态 (例如“已启动”或“已终止”) 示例 : "Started" |
字符串 |
名称 | 说明 | 架构 |
---|---|---|
桶 (必需) |
此 nodearray 的每个分配桶。 “核心计数”设置始终是此存储桶核心计数的倍数。 示例 : [ "object" ] |
<桶> 阵 列 |
maxCoreCount (必需) |
此 nodearray 中可能包含的最大核心数 示例 : 16 |
整型 |
maxCount (必需) |
此 nodearray 中可能包含的最大节点数 示例 : 4 |
整型 |
name (必需) |
此描述的 nodearray 示例 : "execute" |
字符串 |
nodearray (必需) |
此 nodearray 的属性 示例 : "[node](#node)" |
Node |
名称 | 说明 | 架构 |
---|---|---|
activeCoreCount (必需) |
此 nodearray 中用于此存储桶的核心数 示例 : 40 |
整型 |
activeCount (必需) |
此 nodearray 中用于此存储桶的节点数。 这包括仍在获取 VM 的节点。 示例 : 10 |
整型 |
activeNodes (可选) |
此 nodearray 中用于此存储桶的节点名称。 这包括仍在获取 VM 的节点。 仅当 nodes=true 在查询中时,才会包含此值。 示例 : [ "string" ] |
< 字符串 > 数组 |
availableCoreCount (必需) |
在此 nodearray 中,此存储桶中可以创建多少个额外核心。 始终为 availableCount 的倍数。 示例 : 8 |
整型 |
availableCount (必需) |
在此节点数组中,可以在此存储桶中创建多少个额外的节点。 请注意,这可能小于 maxCount 和 usedCount 所暗示的,因为 maxCount 可能受到全局限制。 示例 : 2 |
整型 |
bucketId (必需) |
此存储桶的标识符。 对于 nodearray 中给定的存储桶,只要未删除群集,该值将始终具有相同的值。 示例 : "00000000-0000-0000-0000-000000000000" |
字符串 |
consumedCoreCount (必需) |
此系列已在整个区域中使用的核心数。 示例 : 2 |
整型 |
definition (可选) |
此存储桶的属性,用于从此存储桶创建节点。 create-nodes API 在其 bucket 属性中采用此定义。 示例 : "object" |
definition |
familyConsumedCoreCount (可选) |
此系列已在整个区域中使用的核心数。 示例 : 2 |
整型 |
familyQuotaCoreCount (可选) |
可在此区域中为此系列启动的内核总数。 这可能不是 quotaCount 的整数倍数。 示例 : 16 |
整型 |
familyQuotaCount (可选) |
给定 familyQuotaCoreCount (可以启动的总实例数) 示例 : 4 |
整型 |
invalidReason (必需) |
如果 valid 为 false,则会包含存储桶无效的原因。 目前 NotActivated 和 DisabledMachineType 是唯一的原因。 示例 : "DisabledMachineType" |
字符串 |
lastCapacityFailure (必需) |
自此存储桶上次发生容量故障以来的时长(以秒为单位)。 任何负值都被视为从不。 示例 : 180.0 |
数字 |
maxCoreCount (必需) |
此存储桶中可能的最大核心数,包括全局和 nodearray 限制。 始终是 maxCount 的倍数。 示例 : 16 |
整型 |
maxCount (必需) |
此存储桶中可能的最大节点数,包括全局和 nodearray 限制 示例 : 4 |
整型 |
maxPlacementGroupCoreSize (必需) |
此存储桶中放置组中可包含的最大核心总数。 始终是 maxPlacementGroupSize 的倍数。 示例 : 64 |
整型 |
maxPlacementGroupSize (必需) |
此存储桶中可位于放置组中的最大实例总数 示例 : 16 |
整型 |
placementGroups (必需) |
用于此 nodearray 的放置组(如果有)。 示例 : [ "object" ] |
<placementGroups> 阵 列 |
quotaCoreCount (必需) |
可在此区域中为此系列启动的内核总数,同时考虑区域配额核心计数。 这可能不是 quotaCount 的整数倍数。 示例 : 16 |
整型 |
quotaCount (必需) |
给定 quotaCoreCount (可以启动的总实例数) 示例 : 4 |
整型 |
regionalConsumedCoreCount (可选) |
已在整个区域中使用的核心数。 示例 : 2 |
整型 |
regionalQuotaCoreCount (可选) |
可在此区域中启动的内核总数。 这可能不是 regionalQuotaCount 的整数倍数。 示例 : 16 |
整型 |
regionalQuotaCount (可选) |
给定区域QuotaCoreCount (可以启动的总实例数) 示例 : 4 |
整型 |
valid (必需) |
如果为 true,则此存储桶表示用于新节点的当前有效存储桶。 如果为 false,则此存储桶仅表示现有节点。 示例 : true |
boolean |
virtualMachine (必需) |
从此存储桶启动的虚拟机的属性 示例 : "object" |
virtualMachine |
名称 | 说明 | 架构 |
---|---|---|
machineType (必需) |
虚拟机的 VM 大小 示例 : "A2" |
字符串 |
名称 | 说明 | 架构 |
---|---|---|
activeCoreCount (必需) |
此规模集中有多少个核心 示例 : 16 |
整型 |
activeCount (必需) |
此规模集中有多少个节点 示例 : 4 |
整型 |
name (必需) |
此放置组的唯一标识符 示例 : "my-placement-group" |
字符串 |
名称 | 说明 | 架构 |
---|---|---|
gpuCount (必需) |
此计算机类型具有的 GPU 数 示例 : 2 |
整型 |
infiniband (必需) |
如果此虚拟机支持 InfiniBand 连接 示例 : true |
boolean |
memory (必需) |
此虚拟机中的 RAM(以 GB 为单位) 示例 : 7.5 |
数字 |
pcpuCount (必需) |
此计算机类型具有的物理 CPU 数 示例 : 16 |
整型 |
vcpuCount (必需) |
此计算机类型具有的虚拟 CPU 数 示例 : 32 |
整型 |
vcpuQuotaCount (可选) |
此计算机从配额使用的 vCPU 数 示例 : 2 |
整型 |
ClusterUsage
群集的使用情况和可选成本信息
名称 | 说明 | 架构 |
---|---|---|
usage (必需) |
按时间间隔列出的使用情况列表 示例 : [ "object" ] |
<使用> 阵 列 |
名称 | 说明 | 架构 |
---|---|---|
故障 (必需) |
按“node”和“nodearray”类别划分的此间隔中的使用情况明细 示例 : [ "[clusterusageitem](#clusterusageitem)" ] |
<ClusterUsageItem> 阵 列 |
end (必需) |
间隔结束 (独占) 示例 : "string" |
字符串 |
start (必需) |
间隔的开头 (包括) 示例 : "string" |
字符串 |
total (必需) |
此间隔内此群集的总体使用情况,类别为“群集” 示例 : "[clusterusageitem](#clusterusageitem)" |
ClusterUsageItem |
ClusterUsageItem
名称 | 说明 | 架构 |
---|---|---|
category (必需) |
总体使用情况的“群集”;单个非数组头节点的“节点”;整个 nodearray 的“nodearray” 示例 : "string" |
枚举 (群集、节点、节点数组) |
cost (可选) |
将为此使用量收取的费用,以美元和零售费率为单位。 注意:所有成本金额均为估算值,并不反映实际账单! 示例 : 0.0 |
数字 |
details (可选) |
节点数组使用的 VM 大小的详细信息,包括小时数、core_count、区域优先级和操作系统。 示例 : [ "object" ] |
<细节> 阵 列 |
小时数 (必需) |
此类别的核心使用小时数 示例 : 0.0 |
数字 |
node (可选) |
群集级数据) 不存在 (使用的节点或节点数组的名称 示例 : "string" |
字符串 |
名称 | 说明 | 架构 |
---|---|---|
core_count (可选) |
此 VM 大小中的核心数 示例 : 0.0 |
数字 |
cost (可选) |
此 VM 大小的成本 示例 : 0.0 |
数字 |
小时数 (可选) |
此 VM 大小的使用核心小时数 示例 : 0.0 |
数字 |
os (可选) |
操作系统类型 示例 : "string" |
(Windows、Linux) 枚举 |
priority (可选) |
VM SKU 的优先级 示例 : "string" |
枚举 (常规、现成) |
region (可选) |
VM 大小实例化的区域 示例 : "string" |
字符串 |
vm_size (可选) |
VM SKU 大小 示例 : "string" |
字符串 |
Node
节点记录
类型 : 对象
NodeCreationRequest
指定如何将节点添加到群集
名称 | 说明 | 架构 |
---|---|---|
requestId (可选) |
可选用户提供的唯一令牌,以防止出现网络通信错误时执行重复操作。 如果包含此 ID 并且与以前的请求 ID 匹配,则服务器将忽略此请求并返回 409 错误。 示例 : "00000000-0000-0000-0000-000000000000" |
字符串 |
集 (必需) |
要创建的节点定义列表。 请求必须至少包含一个集。 每个集可以指定一组不同的属性。 示例 : [ "object" ] |
<集> 阵 列 |
名称 | 说明 | 架构 |
---|---|---|
计数 (必需) |
要创建的节点数 示例 : 1 |
整型 |
definition (可选) |
要使用的存储桶的定义。 这由群集状态 API 调用提供。 如果缺少状态调用中提供的某些项,或者缺少整个存储桶属性,则使用与给定项匹配的第一个存储桶。 示例 : "object" |
definition |
nameFormat (可选) |
如果给定,节点将使用此命名约定,而不是标准的“nodearray-%d”格式 示例 : "custom-name-%d" |
字符串 |
nameOffset (可选) |
如果给定,则与 nameFormat 一起偏移新节点的 nodeindex。 示例 : 1 |
整型 |
nodeAttributes (可选) |
要从此集在每个节点上设置的其他属性 示例 : "[node](#node)" |
Node |
nodearray (必需) |
要从中启动节点的 nodearray 的名称 示例 : "execute" |
字符串 |
placementGroupId (可选) |
如果给定,groupId 值相同的节点都将在同一放置组中启动。 示例 : "string" |
字符串 |
名称 | 说明 | 架构 |
---|---|---|
machineType (可选) |
示例 : "A2" |
字符串 |
NodeCreationResult
名称 | 说明 | 架构 |
---|---|---|
operationId (必需) |
此操作的 ID 示例 : "00000000-0000-0000-0000-000000000000" |
字符串 |
集 (必需) |
集数组,顺序与请求中的顺序相同 示例 : [ "object" ] |
<集> 阵 列 |
名称 | 说明 | 架构 |
---|---|---|
添加 (必需) |
此集中已启动多少个节点 示例 : 1 |
整型 |
message (可选) |
指示为何无法添加所有请求的节点(如果存在) 示例 : "string" |
字符串 |
NodeList
节点搜索结果
名称 | 说明 | 架构 |
---|---|---|
节点 (必需) |
返回的节点 示例 : [ "[node](#node)" ] |
<节点> 阵 列 |
operation (可选) |
如果查询包含操作 ID,则这是该操作的状态 示例 : "[operationstatus](#operationstatus)" |
OperationStatus |
NodeManagementRequest
指定如何在群集中的节点上执行操作。 可通过多种方式指定节点,如果包含多个方法,则将其视为联合。
名称 | 说明 | 架构 |
---|---|---|
filter (可选) |
与节点匹配的筛选器表达式。 请注意,表达式中的字符串必须正确引用。 示例 : "State === \"Started\"" |
字符串 |
主机 名 (可选) |
没有要管理的域) (的短主机名列表 示例 : [ "hostname1", "hostname2" ] |
< 字符串 > 数组 |
ids (可选) |
要管理的节点 ID 列表 示例 : [ "id1", "id2" ] |
< 字符串 > 数组 |
ip_addresses (可选) |
要管理的 IP 地址列表 示例 : [ "10.0.1.1", "10.1.1.2" ] |
< 字符串 > 数组 |
名称 (可选) |
要管理的节点名称列表 示例 : [ "name1", "name2" ] |
< 字符串 > 数组 |
requestId (可选) |
可选用户提供的唯一令牌,以防止出现网络通信错误时执行重复操作。 如果包含此 ID 并且与以前的请求 ID 匹配,则服务器将忽略此请求并返回 409 错误。 示例 : "00000000-0000-0000-0000-000000000000" |
字符串 |
NodeManagementResult
名称 | 说明 | 架构 |
---|---|---|
节点 (必需) |
与管理请求中的筛选器匹配的每个节点的信息数组。 每个节点的状态指示它是否受到请求的影响。 示例 : [ "object" ] |
<节点> 阵 列 |
operationId (必需) |
此操作的 ID 示例 : "00000000-0000-0000-0000-000000000000" |
字符串 |
名称 | 说明 | 架构 |
---|---|---|
error (可选) |
如果状态为“错误”,则包含错误消息 示例 : "This node must be terminated before it can be removed" |
字符串 |
id (必需) |
节点的 ID 示例 : "id1" |
字符串 |
name (必需) |
节点的名称 示例 : "name1" |
字符串 |
status (可选) |
确定或错误之一 示例 : "Error" |
枚举 (正常,错误) |
OperationStatus
此节点操作的状态
名称 | 说明 | 架构 |
---|---|---|
action (必需) |
示例 : "string" |
enum (create) |
startTime (必需) |
提交此操作时 示例 : "2020-01-01T12:34:56Z" |
字符串(日期时间) |