Use ListHandshakesForResourceDirectory to query invitations - Resource Management - Alibaba Cloud - Resource Management

Queries invitations in a resource directory.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	The returned result.
TotalCount	integer	The total number of entries returned.	2
RequestId	string	The ID of the request.	9B34724D-54B0-4A51-B34D-4512372FE1BE
PageSize	integer	The number of entries returned per page.	10
PageNumber	integer	The page number of the returned page.	1
Handshakes	object
Handshake	array<object>	The information of the invitations.
	object	The information of an invitation.
Status	string	The status of the invitation. Valid values: Pending: The invitation is waiting for confirmation. Accepted: The invitation is accepted. Cancelled: The invitation is canceled. Declined: The invitation is rejected. Expired: The invitation expires.	Pending
ExpireTime	string	The time when the invitation expires. The time is displayed in UTC.	2018-08-24T09:55:41Z
ResourceDirectoryId	string	The ID of the resource directory.	rd-abcdef****
CreateTime	string	The time when the invitation was created. The time is displayed in UTC.	2018-08-10T09:55:41Z
Note	string	The description of the invitation.	Welcome
TargetEntity	string	The ID or logon email address of the invited account.	someone@example.com
MasterAccountId	string	The ID of the management account of the resource directory.	172841235500****
MasterAccountName	string	The name of the management account of the resource directory.	Alice
ModifyTime	string	The time when the invitation was modified. The time is displayed in UTC.	2018-08-10T09:55:41Z
TargetType	string	The type of the invited account. Valid values: Account: indicates the ID of the account. Email: indicates the logon email address of the account.	Email
HandshakeId	string	The ID of the invitation.	h-ycm4rp****

Examples

Success response

JSON format

{
  "TotalCount": 2,
  "RequestId": "9B34724D-54B0-4A51-B34D-4512372FE1BE",
  "PageSize": 10,
  "PageNumber": 1,
  "Handshakes": {
    "Handshake": [
      {
        "Status": "Pending",
        "ExpireTime": "2018-08-24T09:55:41Z",
        "ResourceDirectoryId": "rd-abcdef****",
        "CreateTime": "2018-08-10T09:55:41Z",
        "Note": "Welcome\n",
        "TargetEntity": "someone@example.com",
        "MasterAccountId": "172841235500****",
        "MasterAccountName": "Alice",
        "ModifyTime": "2018-08-10T09:55:41Z",
        "TargetType": "Email",
        "HandshakeId": "h-ycm4rp****"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	EntityNotExists.ResourceDirectory	The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.