Docs
api
Label
ListLabelsByResourceIds

Get tag list by resource ID - ListLabelsByResourceIds

Overview

Get tag list by resource ID

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is ListLabelsByResourceIds.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
ResourceIds.NstringResource ID ArrayYes
OffsetintList start position offset, default is 0No
LimitintReturn data length, default is 10, maximum 100No

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
TotalCountintTotal Number of Resource TagsNo
Labelsarray[ListLabelsByResourceIdsLabel]Resource Tag ArrayNo

Data Model

ListLabelsByResourceIdsLabel

Field NameTypeDescription InformationRequired
ResourceIdstringResource IDYes
KeystringTag KeyYes
ValuestringTag ValueYes
CategorystringTag type, system: System tag; custom: Custom tagYes

Example

Request Example

https://api.dezai.com/?Action=ListLabelsByResourceIds
&ResourceIds=pXUoXIsY
&Offset=1
&Limit=2

Response Example

{
  "Action": "ListLabelsByResourceIdsResponse",
  "Labels": [
    {
      "Category": "txWdYOgd",
      "Key": "eXGXDGqx",
      "ResourceId": "ElPrCshS",
      "Value": "KDxqnFfY"
    }
  ],
  "RetCode": 0,
  "TotalCount": 5
}