ListHandshakesForResourceDirectory - Resource Management

Queries invitations in a resource directory.

Debugging

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

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
resourcemanager:ListHandshakesForResourceDirectory	List	Handshake acs:resourcemanager::{#accountId}:handshake/	none	none

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

For more information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example
	object
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 []	The information of the invitations.
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 comment on 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

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",
        "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.	The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account.

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

Change history

Change time	Summary of changes	Operation

No change history