- What's New
- Service Overview
- Getting Started
- User Guide
-
API Reference
- Before You Start
- API Overview
- Calling APIs
- APIs
- Permissions and Supported Actions
- Appendixes
- Change History
- General Reference
Copied.
Searching for a Resource Sharing Invitation
Function
This API is used to search for a resource sharing invitation based on certain search criteria.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
POST https://{endpoint}/v1/resource-share-invitations/search
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Security-Token |
No |
String |
Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
resource_share_ids |
No |
Array of strings |
List of resource share IDs. |
resource_share_invitation_ids |
No |
Array of strings |
List of resource sharing invitation IDs. |
status |
No |
String |
Status of the resource sharing invitation. |
limit |
No |
Integer |
Maximum number of entries that can be displayed on a page. |
marker |
No |
String |
Paging location marker. The query starts from the next piece of data indexed by this parameter. You do not need to specify this parameter when you query resources on the first page. When you query resources on subsequent pages, set this parameter to the location returned in the response body for the previous query. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
resource_share_invitations |
Array of ResourceShareInvitation objects |
Details about the resource sharing invitation. |
page_info |
PageInfo object |
Pagination details. |
Parameter |
Type |
Description |
---|---|---|
receiver_account_id |
String |
ID of the account that receives the resource sharing invitation. |
resource_share_id |
String |
ID of the resource share. |
resource_share_name |
String |
Name of the resource share. |
resource_share_invitation_id |
String |
ID of the resource sharing invitation. |
sender_account_id |
String |
ID of the account that sends a resource sharing invitation. |
status |
String |
Status of the resource sharing invitation. |
created_at |
String |
Time when the invitation was created. |
updated_at |
String |
Time when the invitation was last updated. |
Example Requests
Searching for resource sharing invitations based on certain search criteria
POST https://{endpoint}/v1/resource-share-invitations/search { "resource_share_ids" : [ "string" ], "resource_share_invitation_ids" : [ "string" ], "status" : "string", "limit" : 2000, "marker" : "string" }
Example Responses
Status code: 200
Request succeeded.
{ "resource_share_invitations" : [ { "receiver_account_id" : "string", "resource_share_id" : "string", "resource_share_name" : "string", "resource_share_invitation_id" : "string", "sender_account_id" : "string", "status" : "string", "created_at" : "2022-09-23T06:43:43.999Z", "updated_at" : "2022-09-23T06:43:43.999Z" } ], "page_info" : { "previous_marker" : "string", "next_marker" : "string", "current_count" : 2000 } }
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot