UpdateIAM2VirtualID

API Request

URLs
PUT zstack/v1/iam2/virtual-ids/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "updateIAM2VirtualID": {
    "name": "new-name",
    "description": "new-desc",
    "password": "new-password"
  },
  "systemTags": [],
  "userTags": []
}
Note: In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.
Curl Sample
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateIAM2VirtualID":{"name":"new-name","description":"new-desc","password":"new-password"}}' http://localhost:8080/zstack/v1/iam2/virtual-ids/348ac2cc1d9438ffa84878d4cb494234/actions
Request Parameters
Name Type Location Description Optional Value Starting Version
uuid String url The resource UUID. 2.4.0
name String body (contained in the updateIAM2VirtualID structure) Optional. The resource name. 2.4.0
description String body (contained in the updateIAM2VirtualID structure) Optional. The detailed description of the resource. 2.4.0
password String body (contained in the updateIAM2VirtualID structure) Optional. The password. 2.4.0
systemTags List body Optional. The system tags. 2.4.0
userTags List body Optional. The user tags. 2.4.0

API Response

Sample Response
{
  "inventory": {
    "uuid": "4906f550acb843b7ae64c32fbf7251c3",
    "name": "id1",
    "state": "Enabled",
    "attributes": [
      {
        "uuid": "b0926ede396547f9b1f6199c05ffe4d4",
        "name": "attribute-name",
        "value": "attribute-value",
        "type": "Customized"
      }
    ]
  }
}
Name Type Description Starting Version
error ErrorCode The error code. If not null, the operation fails, or vice versa. For more information, see error. 2.4.0
inventory IAM2VirtualIDInventory See inventory. 2.4.0
#error
Name Type Description Starting Version
code String The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. 2.4.0
description String The brief description of the error. 2.4.0
details String The details about the error. 2.4.0
elaboration String The reserved field. Default value: null. 2.4.0
opaque LinkedHashMap The reserved field. Default value: null. 2.4.0
cause ErrorCode The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. 2.4.0
#inventory
Name Type Description Starting Version
uuid String The resource UUID. 2.4.0
name String The resource name. 2.4.0
description String The detailed description of the resource. 2.4.0
createDate Timestamp The creation date. 2.4.0
lastOpDate Timestamp The last operation date. 2.4.0
state State See state. 2.4.0
attributes List See attributes. 2.4.0
#state
Name Type Description Starting Version
name String The resource name. 2.4.0
ordinal int 2.4.0
#attributes
Name Type Description Starting Version
uuid String The resource UUID. 2.4.0
name String The resource name. 2.4.0
value String 2.4.0
type AttributeType See type. 2.4.0
#type
Name Type Description Starting Version
name String The resource name. 2.4.0
ordinal int 2.4.0

SDK Sample

Java SDK
UpdateIAM2VirtualIDAction action = new UpdateIAM2VirtualIDAction();
action.uuid = "348ac2cc1d9438ffa84878d4cb494234";
action.name = "new-name";
action.description = "new-desc";
action.password = "new-password";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateIAM2VirtualIDAction.Result res = action.call();
Python SDK
UpdateIAM2VirtualIDAction action = UpdateIAM2VirtualIDAction()
action.uuid = "348ac2cc1d9438ffa84878d4cb494234"
action.name = "new-name"
action.description = "new-desc"
action.password = "new-password"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateIAM2VirtualIDAction.Result res = action.call()