Get Bindable Resource Custom Attributes

GET/zstack/v1/resource-configurations/bindable
GET/zstack/v1/resource-configurations/bindable/{category}

Headers

Authorization: OAuth the-session-uuid

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/resource-configurations/bindable?category=host
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/resource-configurations/bindable/host?category=host

Parameter List

NameTypeLocationDescriptionAllowed ValuesStarting Version
category (Optional)StringqueryConfiguration category 3.4.0
systemTags (Optional)Listquery  3.4.0
userTags (Optional)Listquery  3.4.0

API Response

Response Example

{
  "bindableConfigs": [
    {
      "name": "cpu.overProvisioning.ratio",
      "category": "host",
      "bindResourceTypes": [
        "HostVO",
        "ClusterVO",
        "ZoneVO"
      ]
    }
  ]
}
NameTypeDescriptionStarting Version
errorErrorCodeThe error code. If not null, the operation failed. This field is null when the operation succeeds. See error for details3.4.0
bindableConfigsListSee bindableConfigs for details3.4.0

error

NameTypeDescriptionStarting Version
codeStringThe error code number. A globally unique identifier for the error, for example, SYS.1000, HOST.10013.4.0
descriptionStringA brief description of the error3.4.0
detailsStringThe detailed error information3.4.0
elaborationStringReserved field. Default is null3.4.0
opaqueLinkedHashMapReserved field. Default is null3.4.0
causeErrorCodeThe root error that caused the current error. If no root error exists, this field is null3.4.0

bindableConfigs

NameTypeDescriptionStarting Version
nameStringConfiguration name3.4.0
categoryStringConfiguration category3.4.0
descriptionStringThe detailed description of the configuration3.4.0
bindResourceTypesListThe resource types that can be bound with the configuration3.4.0

SDK Examples

Java SDK

GetResourceBindableConfigAction action = new GetResourceBindableConfigAction();
action.category = "host";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetResourceBindableConfigAction.Result res = action.call();

Python SDK

GetResourceBindableConfigAction action = GetResourceBindableConfigAction()
action.category = "host"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetResourceBindableConfigAction.Result res = action.call()