Query AccessKey

GET/zstack/v1/accesskeys

GET/zstack/v1/accesskeys/{uuid}

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/accesskeys?q=uuid=fc008e53779632989bf9393ecf074e25

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/accesskeys/f99c1aea4a6e35e4a88c6abfe11cce8d

Queryable Fields

Run the CLI tool, enter QueryAccessKey and press Tab to view all queryable fields and cross-table queryable resource names.

API Response

Response Example

{
  "inventories": [
    {
      "uuid": "12be3dd32afa3cf2afa4c06037f218b7",
      "accountUuid": "324ecf74dd5c3b9a9f2b75edfdbd858f",
      "userUuid": "49c0bc4cfa6d3a67930fe4a4cc32248c",
      "AccessKeyID": "1234567890abcdedfhij",
      "AccessKeySecret": "1234567890abcdedfhij1234567890abcdedfhij",
      "state": "Enabled"
    }
  ]
}

Name	Type	Description	Starting Version
success	boolean		4.0.0
error	ErrorCode	Error code. If not null, the operation failed. This field is null when the operation succeeds. Seeerror	3.2.0
inventories	List	Seeinventories	3.2.0

error

Name	Type	Description	Starting Version
code	String	Error code number. A globally unique identifier for the error, e.g., SYS.1000, HOST.1001	0.6
description	String	Brief description of the error	0.6
details	String	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	Root error. The source error that caused this error. Null if no root cause exists	0.6

inventories

Name	Type	Description	Starting Version
uuid	String	The UUID of the resource. Uniquely identifies the resource	4.0.0
description	String	Detailed description of the resource	4.0.0
accountUuid	String	Account UUID	4.0.0
userUuid	String	This value is deprecated	4.0.0
AccessKeyID	String		4.0.0
AccessKeySecret	String		4.0.0
createDate	Timestamp	Creation time	4.0.0
lastOpDate	Timestamp	Last modification time	4.0.0
state	AccessKeyState	Seestate	4.0.0

state

Name	Type	Description	Starting Version
name	String	Resource name	4.0.0
ordinal	int		4.0.0

SDK Examples

Java SDK

QueryAccessKeyAction action = new QueryAccessKeyAction();
action.conditions = asList("uuid=f0c530f17978349faa8c4736accd0375");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryAccessKeyAction.Result res = action.call();

Python SDK

QueryAccessKeyAction action = QueryAccessKeyAction()
action.conditions = ["uuid=ee3c98b8528e3fe2aa9d817cd48b1358"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryAccessKeyAction.Result res = action.call()