查询自定义属性键

GET/zstack/v1/resource-attributes/keys
GET/zstack/v1/resource-attributes/keys/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/resource-attributes/keys?q=name=OperationsPersonnel
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/resource-attributes/keys/dbd98db0aeb939c38a6574e64b822b7d

可查询字段

运行CLI命令行工具,输入QueryResourceAttributeKey并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例

{
  "inventories": [
    {
      "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"
        }
      ]
    }
  ]
}
名字类型描述起始版本
successboolean查询是否成功4.10.16
inventoriesList详情参考inventories4.10.16
errorErrorCode详情参考error4.10.16

inventories

名字类型描述起始版本
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

QueryResourceAttributeKeyAction action = new QueryResourceAttributeKeyAction();
action.conditions = asList("name=OperationsPersonnel");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryResourceAttributeKeyAction.Result res = action.call();

Python SDK

action = QueryResourceAttributeKeyAction()
action.conditions = ["name=OperationsPersonnel"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()