หน้านี้ยังไม่พร้อมใช้งานในภาษาท้องถิ่นของคุณ เรากำลังพยายามอย่างหนักเพื่อเพิ่มเวอร์ชันภาษาอื่น ๆ เพิ่มเติม ขอบคุณสำหรับการสนับสนุนเสมอมา
- 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 Share
Function
This API is used to search for the details about the resource share that you have created or that shared with you.
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-shares/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 |
---|---|---|---|
limit |
No |
Integer |
Maximum number of entries that can be displayed on a page. |
name |
No |
String |
Name of the resource share. |
marker |
No |
String |
Page marker. |
permission_id |
No |
String |
Permission ID. |
resource_owner |
Yes |
String |
Whether the resource share is created by you (self) or shared with you (other-accounts). |
resource_share_ids |
No |
Array of strings |
List of resource share IDs. |
resource_share_status |
No |
String |
Status of the resource share. |
tag_filters |
No |
Array of TagFilter objects |
Tags attached to the resource share. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
resource_shares |
Array of ResourceShare objects |
List of details about resource shares. |
page_info |
PageInfo object |
Pagination details. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
ID of the resource share. |
name |
String |
Name of the resource share. |
description |
String |
Description of the resource share. |
allow_external_principals |
Boolean |
Whether resources can be shared with any accounts outside the organization. |
owning_account_id |
String |
ID of the resource owner in a resource share. |
status |
String |
Status of the resource share. |
tags |
Array of Tag objects |
List of tags attached to the resource share. |
created_at |
String |
Time when the resource share was created. |
updated_at |
String |
Time when the resource share was last updated. |
Example Requests
Searching for details about a resource share
POST https://{endpoint}/v1/resource-shares/search { "limit" : 2000, "name" : "string", "marker" : "string", "permission_id" : "string", "resource_owner" : "self", "resource_share_ids" : [ "string" ], "resource_share_status" : "string", "tag_filters" : [ { "key" : "string", "values" : [ "string" ] } ] }
Example Responses
Status code: 200
Request succeeded.
{ "resource_shares" : [ { "id" : "string", "name" : "string", "description" : "string", "allow_external_principals" : true, "owning_account_id" : "string", "status" : "string", "tags" : [ { "key" : "string", "value" : "string" } ], "created_at" : "2023-01-06T08:24:55.638Z", "updated_at" : "2023-01-06T08:24:55.638Z" } ], "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