跳转到主要内容
API Explorer|API Explorer
资源中心/云资源池/亲和组相关接口
POSTAffinity Group Operations起始版本 2.3同步需要认证

创建亲和组

创建亲和组

调试可用性

在线调试

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

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • nameString必填

      资源名称

    • descriptionString

      资源的详细描述

    • policyString必填

      亲和组策略

    • typeString

      亲和组类型 目前支持物理机亲和 未来将增加网络亲和、路由器亲和、数据中心或机架亲和等多种类型

    • resourceUuidString

      资源UUID

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • 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必填

        亲和组UUID

      • resourceUuidString必填

        加入亲和组的资源UUID

      • resourceTypeString必填

        加入亲和组的资源类型

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

POST/zstack/v1/affinity-groups

/zstack/v1/affinity-groups

操作 ID

CreateAffinityGroup

永久链接

请求示例

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

响应示例

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

变更历史

此 API 暂无变更历史记录。

查看全部变更历史