Tag List - ListLabels

Overview

Tag List

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `ListLabels`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
Category	string	Tag type, system: System tag; custom: Custom tag	Yes
Offset	int	List start position offset, default is 0	No
Limit	int	Return data length, default is 10, maximum 100	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
TotalCount	int	Total Number of Tags	No
Labels	array[ListLabelsLabel]	Tag Array	No

Data Model

ListLabelsLabel

Field Name	Type	Description Information	Required
Key	string	Tag Key	Yes
Value	string	Tag Value	Yes
ResourceCount	int	Resource Quantity	Yes

Example

Request Example

https://api.surfercloud.com/?Action=ListLabels
&Category=rOXertdp
&Offset=6
&Limit=9

Response Example

{
  "Action": "ListLabelsResponse",
  "Labels": [
    {
      "Key": "rtvfJqwC",
      "ResourceCount": 5,
      "Value": "pxqqmyZV"
    }
  ],
  "RetCode": 0,
  "TotalCount": 7
}

DeleteLabels ListLabelsByResourceIds