Get tag list by resource ID - ListLabelsByResourceIds
Overview
Get tag list by resource ID
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is ListLabelsByResourceIds . | Yes |
PublicKey | string | The user’s public key can be obtained from Console | 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 |
---|---|---|---|
ResourceIds.N | string | Resource ID Array | 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 Resource Tags | No |
Labels | array[ListLabelsByResourceIdsLabel] | Resource Tag Array | No |
Data Model
ListLabelsByResourceIdsLabel
Field Name | Type | Description Information | Required |
---|---|---|---|
ResourceId | string | Resource ID | Yes |
Key | string | Tag Key | Yes |
Value | string | Tag Value | Yes |
Category | string | Tag type, system: System tag; custom: Custom tag | Yes |
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
}