跳转到主要内容
API Explorer|API Explorer
资源中心/云资源池/云主机调度策略相关接口
POSTVM Scheduling Rule Group Operations起始版本 4.6.0同步需要认证

创建云主机调度策略

创建云主机调度策略

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • ruleString必填

      规则

    • modeString必填

      执行力度

    • vmGroupUuidString必填

      VM调度组UUID

    • hostGroupUuidString

      物理机调度组UUID

    • nameString必填

      资源名称

    • descriptionString

      资源的详细描述

    • policyString

      策略。

    • typeString

      类型。

    • zoneUuidString

      区域UUID

    • subTypeString

      订阅类型。

    • resourceUuidString

      资源UUID

    • tagUuidsList

      标签UUID列表

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventoryAffinityGroupInventory必填

    详情参考inventory

    • uuidString必填

      资源的UUID，唯一标示该资源

    • nameString必填

      资源名称

    • descriptionString

      资源的详细描述

    • policyString必填

      策略信息。

    • versionString必填

      版本号。

    • typeString必填

      类型。

    • applianceString必填

      设备。

    • stateString必填

      当前状态。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • usagesList必填

      详情参考usages

      • uuidString必填

        资源的UUID，唯一标示该资源

      • affinityGroupUuidString必填

        暂无描述。

      • resourceUuidString必填

        资源UUID。若指定，资源会使用该字段值作为UUID。

      • resourceTypeString必填

        资源类型。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

POST/zstack/v1/vmsSchedulingRule

/zstack/v1/vmsSchedulingRule

操作 ID

CreateVmSchedulingRule

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/vmsSchedulingRule' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"rule":"<rule>","mode":"<mode>","vmGroupUuid":"<vmGroupUuid>","hostGroupUuid":"<hostGroupUuid>","name":"<name>","description":"<description>","policy":"<policy>","type":"<type>","zoneUuid":"<zoneUuid>","subType":"<subType>","resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "d517b42f669b324288fe8977a7df2e4d", "name": "affinity-group-test", "description": "affinity group for test", "policy": "ANTISOFT", "version": "1.0", "type": "HOST" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史