ListResourceShareInvitations
Queries the resource sharing invitations received by a resource principal.
Operation description
Usage notes
This topic provides an example to query the resource sharing invitations received by the current account in the cn-hangzhou region. The response shows that one invitation is received and is in the Pending state.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
resourcesharing:ListResourceShareInvitations |
list |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| MaxResults |
integer |
No |
The maximum number of entries to return for a single request. Valid values: 1 to 100. Default value: 20. |
20 |
| NextToken |
string |
No |
The pagination token that is used to retrieve the next page of results when the response is truncated. You can use this token to initiate another request to obtain the remaining results. |
TGlzdFJlc291cm**** |
| ResourceShareIds |
array |
No |
The IDs of the resource shares. |
|
|
string |
No |
The IDs of the resource shares. |
rs-ysGRci9z**** |
|
| ResourceShareInvitationIds |
array |
No |
The IDs of the resource sharing invitations. |
|
|
string |
No |
The IDs of the resource sharing invitations. |
i-p6eRytrkjVvM**** |
For more information about common request parameters, see Common parameters.
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response. |
||
| NextToken |
string |
The pagination token that is used to retrieve the next page of results when the response is truncated. You can use this token to initiate another request to obtain the remaining results. |
TGlzdFJlc291cm**** |
| RequestId |
string |
The ID of the request. |
30EC8328-1BDE-51D5-BFAB-039508BD91A1 |
| ResourceShareInvitations |
array<object> |
The information about the resource sharing invitations. |
|
|
array<object> |
The information about the resource sharing invitations. |
||
| Status |
string |
The status of the invitation. Valid values:
|
Pending |
| CreateTime |
string |
The time when the invitation was created. The time is displayed in UTC. |
2022-08-18T05:36:45.024Z |
| ResourceShareId |
string |
The IDs of the resource shares. |
rs-ysGRci9z**** |
| ResourceShareName |
string |
The name of the resource share. |
example |
| SenderAccountId |
string |
The Alibaba Cloud account ID of the sender. |
151266687691**** |
| ReceiverAccountId |
string |
The Alibaba Cloud account ID of the receiver. |
134254031178**** |
| ResourceShareInvitationId |
string |
The IDs of the resource sharing invitations. |
i-p6eRytrkjVvM**** |
| InvitationFailedDetails |
array<object> |
The detailed reasons why the check for accepting the resource sharing invitation or leaving the resource share failed. |
|
|
object |
The detailed reasons why the check for accepting the resource sharing invitation or leaving the resource share failed. |
||
| Status |
string |
[Deprecated] Use FailureReason instead. |
None |
| StatusMessage |
string |
[Deprecated] Use FailureDescription instead. |
None |
| AssociateType |
string |
[Deprecated] Use OperationType instead. |
None |
| ResourceArn |
string |
The ARN of the shared resource. |
acs:vpc:cn-shanghai:103755469187****:vswitch/vsw-uf62b11ue4m8oz2di**** |
| ResourceType |
string |
The type of the shared resource. For more information about the resource types that support resource sharing, see Cloud services that support Resource Sharing. |
Snapshot |
| FailureReason |
string |
The reason why the check for accepting the invitation or leaving the resource share failed. Valid values:
|
Unavailable |
| FailureDescription |
string |
The detailed description of the reason why the check for accepting the invitation or leaving the resource share failed. |
You cannot access the specified resource at this time. |
| OperationType |
string |
The type of the operation. Valid values:
|
Associate |
| ResourceId |
string |
The ID of the shared resource. |
s-7xvh46nx5oqlre0wv*** |
Examples
Success response
JSON format
{
"NextToken": "TGlzdFJlc291cm****",
"RequestId": "30EC8328-1BDE-51D5-BFAB-039508BD91A1",
"ResourceShareInvitations": [
{
"Status": "Pending",
"CreateTime": "2022-08-18T05:36:45.024Z",
"ResourceShareId": "rs-ysGRci9z****",
"ResourceShareName": "example",
"SenderAccountId": "151266687691****",
"ReceiverAccountId": "134254031178****",
"ResourceShareInvitationId": "i-p6eRytrkjVvM****",
"InvitationFailedDetails": [
{
"Status": "None",
"StatusMessage": "None",
"AssociateType": "None",
"ResourceArn": "acs:vpc:cn-shanghai:103755469187****:vswitch/vsw-uf62b11ue4m8oz2di****",
"ResourceType": "Snapshot",
"FailureReason": "Unavailable",
"FailureDescription": "You cannot access the specified resource at this time.",
"OperationType": "Associate",
"ResourceId": "s-7xvh46nx5oqlre0wv***"
}
]
}
]
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParameter.MaxResults | The MaxResults is invalid. | The MaxResults parameter is invalid. |
| 400 | InvalidParameter.NextToken | The NextToken is invalid. | The NextToken parameter is invalid. |
| 400 | InvalidParameter.NextToken.Length | The maximum length of NextToken exceeds 256 characters. | The length of NextToken cannot exceed 256 characters. |
| 400 | InvalidParameter.ResourceShareIds | The ResourceShareIds is invalid. | The ResourceShareIds parameter is invalid. |
| 400 | InvalidParameter.ResourceShareIds.Duplicate | The ResourceShareIds contains duplicate values. | The ResourceShareIds parameter contains duplicate values. |
| 400 | InvalidParameter.ResourceShareIds.Length | The maximum length of ResourceShareIds exceeds 5 characters. | The number of ResourceShareIds values cannot exceed 5. |
| 400 | InvalidParameter.ResourceShareInvitationIds | The ResourceShareInvitationIds is invalid. | The value of ResourceShareInvitationIds is invalid. |
| 400 | InvalidParameter.ResourceShareInvitationIds.Duplicate | The ResourceShareInvitationIds duplicate values. | ResourceShareInvitationIds is already configured. |
| 400 | InvalidParameter.ResourceShareInvitationIds.Length | The maximum length of ResourceShareInvitationIds exceeds quota limit. | The length of the value specified for ResourceShareInvitationIds exceeds the limit. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.