AccessKey

Overview

An AccessKey can either be a local AccessKey or a third-party AccessKey.

In ZStack CloudPrivate Cloud, a local AccessKey (which contains an AccessKey ID and an AccessKey Secret) is a security credential authorized by the Cloud to third-party users. With the authorized AccessKey, third-party users can access cloud resources by calling ZStack CloudPrivate Cloud APIs. We recommend that you keep your AccessKey confidential to maintain securities.
A third-party AccessKey (which contains an AccessKey ID and an AccessKey Secret) is a security credential authorized by third-party users to the Cloud. With the authorized AccessKey, the Cloud can access cloud resources of the third-party users by calling APIs. Third-party AccessKey must also be kept confidential to maintain security.

AccessKey is a key factor for ZStack CloudPrivate Cloud to perform security authentication on API requests. We recommend that you keep your AccessKey confidential to maintain securities. If your AccessKey is at risk of leakage, we recommend that you delete it in time and create a new one.

Notice

Admins and platform admins can create multiple AccessKeys, while the tenants (normal accounts and project members) can create only two AccessKeys.
Admins and platform admins can enable, disable, or delete AccessKeys created by themselves and those created by tenants at any time.
Tenants can enable, disable, or delete AccessKeys created by themselves at any time.
An AccessKey has all permissions of the person who created it.

Inventory

Properties

Name	Description	Optional	Valid Value	Starting Version
uuid	The UUID. For more information, see Resource Property.			3.2.0
description	The detailed description of the resource.	Yes		3.2.0
state	The state. For more information, see Resource Property.		Enabled Disabled	3.2.0
accountUuid	The account UUID.			3.2.0
userUuid	The user UUID.			3.2.0
AccessKeyID				3.2.0
AccessKeySecret				3.2.0
groupBy				3.2.0
createDate	The creation date. For more information, see Resource Property.			3.2.0
lastOpDate	The last operation date. For more information, see Resource Property.			3.2.0
systemTags
userTags

Sample

{
    "inventories": [
        {
            "AccessKeyID": "PqCuIU6dKGOZkMRB0kcY",
            "AccessKeySecret": "WijjWZuKYDX2j7HdJA99qVkvVdRzCm5AyBaRpVwt",
            "accountUuid": "36c27e8ff05c4780bf6d2fa65700f22e",
            "createDate": "Dec 4, 2018 10:40:25 AM",
            "description": "",
            "lastOpDate": "Dec 4, 2018 10:40:25 AM",
            "state": "Enabled",
            "userUuid": "36c27e8ff05c4780bf6d2fa65700f22e",
            "uuid": "fff6c1a0d0594124a43debd83f01bda5"
        }
    ],
    "success": true
}

Operations

CreateAccessKey

Creates an AccessKey. For example,

CreateAccessKey accountUuid=aac1b2040c144342a17182514ff0d072 userUuid=36c27e8ff05c4780bf6d2fa65700f22e

Parameters

Name	Description	Optional	Starting Version
accountUuid	The account UUID.		3.2.0
userUuid	The user UUID.		3.2.0
description	The detailed description of the resource.	Yes	3.2.0
AccessKeyID	The AccessKey ID.	Yes	3.7.0
AccessKeySecret	The AccessKey Secret.	Yes	3.7.0
resourceUuid		Yes	3.2.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.2.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.2.0
timeout		Yes

DeleteAccessKey

Creates an AccessKey. For example,

DeleteAccessKey uuid=aac1b2040c144342a17182514ff0d072

Parameters

Name	Description	Optional	Starting Version
uuid	The AccessKey UUID.		3.2.0
deleteMode			3.2.0
userTags	The user tags. For more information, see CreateUserTag.	Yes	3.2.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes	3.2.0
timeout		Yes

QueryAccessKey

Queries an AccessKey. For example,

QueryAccessKey

Primitive Fields of Query

See AccessKey Inventory.

ChangeAccessKeyState

Enables or disables an AccessKey. For example,

ChangeAccessKeyState uuid=aac1b2040c144342a17182514ff0d072 stateEvent=disable

Parameters

Name	Description	Optional	Valid Value	Starting Version
uuid	The AccessKey UUID.			3.2.0
stateEvent	Enables or disables the AccessKey.		enable disable	3.2.0
userTags	The user tags. For more information, see CreateUserTag.	Yes		3.2.0
systemTags	The system tags. For more information, see CreateSystemTag.	Yes		3.2.0
timeout		Yes

AccessKey

Overview

Notice

Inventory

Properties

Sample

Operations

CreateAccessKey

Parameters

DeleteAccessKey

Parameters

QueryAccessKey

Primitive Fields of Query

ChangeAccessKeyState

Parameters

Tags