Invites an account to join a resource directory.
Operation description
This topic provides an example on how to call the API operation to invite the account someone@example.com
to join a resource directory.
Debugging
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:InviteAccountToResourceDirectory | Write |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
TargetEntity | string | Yes | The ID or logon email address of the account that you want to invite. | someone@example.com |
TargetType | string | Yes | The type of the account. Valid values:
| |
Note | string | No | The comment on the invitation. The comment can be up to 1,024 characters in length. | Welcome |
Tag | object [] | No | The tag key and value. | |
Key | string | No | A tag key. | k1 |
Value | string | No | A tag value. | v1 |
For more information about common request parameters, see Common parameters.
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "9B34724D-54B0-4A51-B34D-4512372FE1BE",
"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 |
---|---|---|---|
400 | MissingParameter.TargetEntity | You must specify TargetEntity. | - |
400 | InvalidParameter.TargetEntity | The TargetEntity is invalid. | - |
400 | MissingParameter.TargetType | You must specify TargetType. | - |
400 | InvalidParameter.TargetType | The TargetType is invalid. | - |
400 | InvalidParameter.Note.Length | The length of the invitation note exceeds the limit. | - |
400 | InvalidParameter.Note | The Note is invalid. | - |
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. |
409 | LimitExceeded.Account | The maximum number of member accounts in a resource directory exceeds the limit. | The maximum number of member accounts in a resource directory exceeds the limit. |
409 | LimitExceeded.InvitationRate | The number of invitations sent exceeds the limit. | - |
409 | EntityAlreadyExists.Handshake | Handshakes with the same target entity already exist. | - |
409 | NotSupport.AccountInAnotherResourceDirectory | The specified account is an Alibaba Cloud account or already exists in another resource directory. | - |
409 | LegalEntityMismatch | Your account does not have the same legal entity as the master account. | - |
409 | Invalid.AccountType | The specified profile type of account is invalid. | The specified AccountType is invalid. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2023-09-04 | The Error code has changed | see changesets | ||||||||
|