ZStack ZSphere Documentation
All Version
All
ZStack ZSphere Documentation>ZSphere API Reference(v5.0.0)>O&M Management>Custom Attribute
Get PDF

Create Custom Attribute Key (CreateResourceAttributeKey)

API Request

URLs
POST zstack/v1/resource-attributes
Headers
Authorization: OAuth the-session-uuid
Body
{   "params": {     "name": "Operations personnel"   },   "systemTags": [],   "userTags": [] }
Note: In the above example, the systemTags and userTags fields can be omitted. They are listed to show that these two fields can be included in the body.
Curl Example
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"name":"Operations personnel"}}' \ http://localhost:8080/zstack/v1/resource-attributes
Parameter List
Name Type Location Description Allowed Values Starting Version
name String body (contained in the params structure) Custom attribute key name 4.10.16
description (optional) String body (contained in the params structure) Detailed description of the resource 4.10.16
resourceTypes (optional) List body (contained in the params structure) List of resource types supported by this attribute. Defaults to all supported types 4.10.16
constraints (optional) List body (contained in the params structure) Attribute constraint list 4.10.16
resourceUuid (optional) String body (contained in the params structure) Resource UUID 4.10.16
tagUuids (optional) List body (contained in the params structure) Tag UUID list 4.10.16
systemTags (optional) List body System tags 4.10.16
userTags (optional) List body User tags 4.10.16

API Response

Response example
{   "inventory": {     "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"       }     ]   } }
Name Type Description Starting Version
success boolean Whether the creation succeeded 4.10.16
inventory ResourceAttributeKeyInventory For details, see inventory 4.10.16
error ErrorCode Error code. If not null, the operation failed. This field is null when the operation succeeds. For details, see error 0.6
#inventory
Name Type Description Starting Version
uuid String Custom attribute key UUID 4.10.16
name String Custom attribute key name 4.10.16
description String Detailed description of the resource 4.10.16
createDate Timestamp Creation time 4.10.16
lastOpDate Timestamp Last modification time 4.10.16
#error
Name Type Description Starting Version
ode String The error code number, a globally unique identifier for the error, e.g., SYS.1000, HOST.1001 0.6
description String A brief description of the error 0.6
details String The detailed error information 0.6
elaboration String Reserved field. Defaults to null 0.6
opaque LinkedHashMap Reserved field. Defaults to null 0.6
cause ErrorCode The root error, the cause of the current error. This field is null if there is no root error 0.6

SDK Examples

Java SDK
CreateResourceAttributeKeyAction action = new CreateResourceAttributeKeyAction(); action.name = "Operations personnel"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; CreateResourceAttributeKeyAction.Result res = action.call();
Python SDK
action = CreateResourceAttributeKeyAction() action.name = "Operations personnel" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" res = action.call()

Delete Custom Attribute Key (DeleteResourceAttributeKey)

API Request

URLs
DELETE zstack/v1/resource-attributes/{uuid}
Headers
Authorization: OAuth the-session-uuid
Curl Example
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X DELETE http://localhost:8080/zstack/v1/resource-attributes/ff03a2b491023030bf58b1b35ea9cd00?deleteMode=Permissive
Parameter List
Name Type Location Description Allowed Values Starting Version
uuid String url Custom attribute key UUID 4.10.16
deleteMode (optional) String query Deletion mode (Permissive or Enforcing, defaults to Permissive) 4.10.16
systemTags (optional) List query System tags 4.10.16
userTags (optional) List query User tags 4.10.16

API Response

On success, this API returns an empty JSON structure {}. On error, the returned JSON structure contains an error field, for example:
{ 	"error": { 		"code": "SYS.1001", 		"description": "A message or a operation timeout", 		"details": "Create VM on KVM timeout after 300s" 	} }

SDK Examples

Java SDK
DeleteResourceAttributeKeyAction action = new DeleteResourceAttributeKeyAction(); action.uuid = "ff03a2b491023030bf58b1b35ea9cd00"; action.deleteMode = "Permissive"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; DeleteResourceAttributeKeyAction.Result res = action.call();
Python SDK
action = DeleteResourceAttributeKeyAction() action.uuid = "ff03a2b491023030bf58b1b35ea9cd00" action.deleteMode = "Permissive" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" res = action.call()

Update Custom Attribute Key (UpdateResourceAttributeKey)

API Request

URLs
PUT zstack/v1/resource-attributes/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{   "updateResourceAttributeKey": {     "description": "test"   },   "systemTags": [],   "userTags": [] }
Note: In the above example, the systemTags and userTags fields can be omitted. They are listed to show that these two fields can be included in the body.
Curl Example
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X PUT -d '{"updateResourceAttributeKey":{"description":"test"}}' \ http://localhost:8080/zstack/v1/resource-attributes/ff03a2b491023030bf58b1b35ea9cd00/actions
Parameter List
Name Type Location Description Allowed Values Starting Version
uuid String url Custom attribute key UUID 4.10.16
name (optional) String body (contained in the updateResourceAttributeKey structure) Key name 4.10.16
description (optional) String body (contained in the updateResourceAttributeKey structure) Detailed description of the resource 4.10.16
resourceTypes (optional) List body (contained in the updateResourceAttributeKey structure) List of resource types supported by this attribute 4.10.16
createConstraints (optional) List body (contained in the updateResourceAttributeKey structure) Newly created constraints 4.10.16
updateConstraints (optional) List body (contained in the updateResourceAttributeKey structure) Updated constraints 4.10.16
deleteConstraintIds (optional) List body (contained in the updateResourceAttributeKey structure) List of constraint IDs to delete 4.10.16
systemTags (optional) List body System tags 4.10.16
userTags (optional) List body User tags 4.10.16

API Response

Response example
{   "inventory": {     "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"       }     ]   } }
Name Type Description Starting Version
success boolean Whether the update succeeded 4.10.16
inventory ResourceAttributeKeyInventory For details, see inventory 4.10.16
error ErrorCode For details, see error 4.10.16
#inventory
Name Type Description Starting Version
uuid String Custom attribute key UUID 4.10.16
name String Custom attribute key name 4.10.16
description String Detailed description of the resource 4.10.16
createDate Timestamp Creation time 4.10.16
lastOpDate Timestamp Last modification time 4.10.16
#error
Name Type Description Starting Version
ode String The error code number, a globally unique identifier for the error, e.g., SYS.1000, HOST.1001 0.6
description String A brief description of the error 0.6
details String The detailed error information 0.6
elaboration String Reserved field. Defaults to null 0.6
opaque LinkedHashMap Reserved field. Defaults to null 0.6
cause ErrorCode The root error, the cause of the current error. This field is null if there is no root error 0.6

SDK Examples

Java SDK
UpdateResourceAttributeKeyAction action = new UpdateResourceAttributeKeyAction(); action.uuid = "ff03a2b491023030bf58b1b35ea9cd00"; action.description = "test"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; UpdateResourceAttributeKeyAction.Result res = action.call();
Python SDK
action = UpdateResourceAttributeKeyAction() action.uuid = "ff03a2b491023030bf58b1b35ea9cd00" action.description = "test" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" res = action.call()




Archives

Download Document Archives

Download

Already filled the basic info?Click here.

Enter at least 2 characters.
Cannot be empty.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

An email with a verification code will be sent to you. Make sure the address you provided is valid and correct.

同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

Download

Not filled the basic info yet? Click here.

Invalid email address or mobile number.
同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

Email Us

contact@zstack.io
ZStack Training and Certification
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

Email Us

contact@zstack.io
Request Trial
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

Email Us

contact@zstack.io

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder. After receiving the email, click the URL to download the documentation.

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder.
Or click on the URL below. (For Internet Explorer, right-click the URL and save it.)

Thank you for using ZStack products and services.

Submit successfully.

We'll connect soon.

Thank you for using ZStack products and services.