All Products
Search
Document Center

Resource Management:ListHandshakesForAccount

Last Updated:Jun 25, 2024

Queries the invitations that are associated with an account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The number of the page to return.

Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page.

Valid values: 1 to 100. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

TotalCountinteger

The total number of invitations.

2
RequestIdstring

The ID of the request.

9B34724D-54B0-4A51-B34D-4512372FE1BE
PageSizeinteger

The number of entries returned per page.

10
PageNumberinteger

The page number of the returned page.

1
Handshakesobject []

The information of the invitations.

Statusstring

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
ExpireTimestring

The time when the invitation expires. The time is displayed in UTC.

2018-08-24T09:55:41Z
ResourceDirectoryIdstring

The ID of the resource directory.

rd-abcdef****
CreateTimestring

The time when the invitation was created. The time is displayed in UTC.

2018-08-10T09:55:41Z
Notestring

The description of the invitation.

Welcome
TargetEntitystring

The ID or logon email address of the invited Alibaba Cloud account.

someone@example.com
MasterAccountIdstring

The ID of the management account of the resource directory.

172841235500****
MasterAccountNamestring

The name of the management account of the resource directory.

CompanyA
ModifyTimestring

The time when the invitation was modified. The time is displayed in UTC.

2018-08-10T09:55:41Z
TargetTypestring

The type of the invited Alibaba Cloud account. Valid values:

  • Account: indicates the ID of the account.
  • Email: indicates the logon email address of the account.
Email
HandshakeIdstring

The ID of the invitation.

h-4N57QZzCTtES****

Examples

Sample success responses

JSONformat

{
  "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": "CompanyA",
        "ModifyTime": "2018-08-10T09:55:41Z",
        "TargetType": "Email",
        "HandshakeId": "h-4N57QZzCTtES****"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history