Querying Tags Used by Resource Shares

Function

This API is used to query the list of tags used by resource shares.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET https://{endpoint}/v1/resource-shares/tags

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Maximum number of entries that can be displayed on a page.
marker	No	String	Page marker.

Request Parameters

**Table 2** Request header 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.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
tags	Array of TagDTO objects	List of one or more tag key-value pairs. The tag key cannot be left blank or be an empty string. The tag value must be specified and can be an empty string.
page_info	PageInfoMarkerByKey object	Pagination details.

**Table 4** TagDTO
Parameter	Type	Description
key	String	Identifier or name of the tag key. You can set the tag value to an empty string, but cannot set it to null.
values	Array of strings	List of values. Each value can contain a maximum of 255 characters.

**Table 5** PageInfoMarkerByKey
Parameter	Type	Description
previous_marker	String	Marker of the previous page.
next_marker	String	Marker of the next page.
current_count	Integer	Number of pages.

Example Requests

Querying the list of tags used by a resource share

GET https://{endpoint}/v1/resource-shares/tags

Example Responses

Status code: 200

Request succeeded.

{
  "tags" : [ {
    "key" : "string",
    "values" : [ "string" ]
  } ],
  "page_info" : {
    "previous_marker" : "string",
    "next_marker" : "string",
    "current_count" : 2000
  }
}