跳转到主要内容
运维管理/自定义属性相关接口
GETCustom Attribute起始版本 4.10.16同步需要认证

查询自定义属性键

查询自定义属性键

调试可用性

在线调试

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

请求参数

此接口无需请求参数。

响应状态

200 OK

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

  • successboolean必填

    查询是否成功

  • inventoriesList必填

    详情参考inventories

    • uuidString必填

      自定义属性键 UUID

    • nameString必填

      自定义属性键名称

    • descriptionString必填

      资源的详细描述

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

  • errorErrorCode必填

    详情参考error

    • odeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段,默认为null

    • opaqueLinkedHashMap必填

      保留字段,默认为null

    • causeErrorCode必填

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

请求地址

GET/zstack/v1/resource-attributes/keys

/zstack/v1/resource-attributes/keys

操作 ID

QueryResourceAttributeKey

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/resource-attributes/keys' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "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" } ] } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史