自定义属性相关接口

创建自定义属性值

POST/zstack/v1/resource-attributes/{keyUuid}/resources

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "value": "Kinny",
    "resourceUuids": [
      "ff01ec80fd11327cba7519b66119d900"
    ]
  },
  "systemTags": [],
  "userTags": []
}

上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"value":"Kinny","resourceUuids":["ff01ec80fd11327cba7519b66119d900"]}}' \
http://localhost:8080/zstack/v1/resource-attributes/ff03a2b491023030bf58b1b35ea9cd00/resources

参数列表

名字类型位置描述可选值起始版本
keyUuidStringurl自定义属性键 UUID 4.10.16
valueStringbody(包含在params结构中)值 4.10.16
resourceUuidsListbody(包含在params结构中)资源 UUID 4.10.16
systemTags (可选)Listbody系统标签 4.10.16
userTags (可选)Listbody用户标签 4.10.16

API返回

返回示例

{
  "inventories": [
    {
      "inventory": {
        "keyUuid": "ff03a2b491023030bf58b1b35ea9cd00",
        "key": {
          "uuid": "ff03a2b491023030bf58b1b35ea9cd00",
          "name": "OperationsPersonnel",
          "description": "Kinny",
          "resourceTypes": [
            "VmInstanceVO"
          ],
          "createDate": "Nov 14, 2017 2:20:57 PM",
          "lastOpDate": "Nov 14, 2017 2:20:57 PM",
          "constraints": [
            {
              "id": 1,
              "keyUuid": "ff03a2b491023030bf58b1b35ea9cd00",
              "type": "option",
              "parameter": "Kinny",
              "createDate": "Nov 14, 2017 2:20:57 PM",
              "lastOpDate": "Nov 14, 2017 2:20:57 PM"
            }
          ]
        },
        "value": "Kinny",
        "resourceUuid": "ff01ec80fd11327cba7519b66119d900",
        "resourceType": "VmInstanceVO",
        "createDate": "Nov 14, 2017 2:20:57 PM"
      },
      "success": true
    }
  ]
}
名字类型描述起始版本
successboolean创建是否成功4.10.16
inventoriesList详情参考inventories4.10.16
errorErrorCode详情参考error4.10.16

inventories

名字类型描述起始版本
successboolean创建是否成功4.10.16
errorErrorCode详情参考error4.10.16
inventoryResourceAttributeValueInventory详情参考inventory4.10.16

error

名字类型描述起始版本
odeString错误码号，错误的全局唯一标识，例如SYS.1000, HOST.10010.6
descriptionString错误的概要描述0.6
detailsString错误的详细信息0.6
elaborationString保留字段，默认为null0.6
opaqueLinkedHashMap保留字段，默认为null0.6
causeErrorCode根错误，引发当前错误的源错误，若无原错误，该字段为null0.6

inventory

名字类型描述起始版本
keyUuidString自定义属性键 UUID4.10.16
valueString值4.10.16
resourceUuidString资源 UUID4.10.16
resourceTypeString资源类型4.10.16
createDateTimestamp创建时间4.10.16
keyResourceAttributeKeyInventory详情参考key4.10.16

key

名字类型描述起始版本
uuidString自定义属性键 UUID4.10.16
nameString自定义属性键名称4.10.16
descriptionString资源的详细描述4.10.16
createDateTimestamp创建时间4.10.16
lastOpDateTimestamp最后一次修改时间4.10.16

error

名字类型描述起始版本
odeString错误码号，错误的全局唯一标识，例如SYS.1000, HOST.10010.6
descriptionString错误的概要描述0.6
detailsString错误的详细信息0.6
elaborationString保留字段，默认为null0.6
opaqueLinkedHashMap保留字段，默认为null0.6
causeErrorCode根错误，引发当前错误的源错误，若无原错误，该字段为null0.6

SDK示例

Java SDK

CreateResourceAttributeValueAction action = new CreateResourceAttributeValueAction();
action.keyUuid = "ff03a2b491023030bf58b1b35ea9cd00";
action.value = "Kinny";
action.resourceUuids = asList("ff01ec80fd11327cba7519b66119d900");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateResourceAttributeValueAction.Result res = action.call();

Python SDK

action = CreateResourceAttributeValueAction()
action.keyUuid = "ff03a2b491023030bf58b1b35ea9cd00"
action.value = "Kinny"
action.resourceUuids = [ff01ec80fd11327cba7519b66119d900]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

GET查询自定义属性键

上一页

DELETE删除自定义属性值

下一页