# 标签列表 - ListLabels

## 简介

标签列表





## 定义

### 公共参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Action**     | string  | 对应的 API 指令名称，当前 API 为 `ListLabels`                        | **Yes** |
| **PublicKey**  | string  | 用户公钥，可从 [控制台](https://console.dezai.com/uaccount/api_manage) 获取                                             | **Yes** |
| **Signature**  | string  | 根据公钥及 API 指令生成的用户签名，参见 [签名算法](/docs/api/summary/signature.md)  | **Yes** |

### 请求参数

| 参数名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Category** | string | 标签类型，system：系统标签；custom：自定义标签 |**Yes**|
| **Offset** | int | 列表起始位置偏移量，默认为0 |No|
| **Limit** | int | 返回数据长度，默认为10，最大100 |No|

### 响应字段

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **RetCode** | int | 返回状态码，为 0 则为成功返回，非 0 为失败 |**Yes**|
| **Action** | string | 操作指令名称 |**Yes**|
| **Message** | string | 返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息 |No|
| **TotalCount** | int | 标签总数 |No|
| **Labels** | array[[*ListLabelsLabel*](#ListLabelsLabel)] | 标签数组 |No|

#### 数据模型


#### ListLabelsLabel

| 字段名 | 类型 | 描述信息 | 必填 |
|:---|:---|:---|:---|
| **Key** | string | 标签键 |**Yes**|
| **Value** | string | 标签值 |**Yes**|
| **ResourceCount** | int | 资源数量 |**Yes**|

## 示例

### 请求示例
    
```
https://api.dezai.com/?Action=ListLabels
&Category=rOXertdp
&Offset=6
&Limit=9
```

### 响应示例
    
```json
{
  "Action": "ListLabelsResponse",
  "Labels": [
    {
      "Key": "rtvfJqwC",
      "ResourceCount": 5,
      "Value": "pxqqmyZV"
    }
  ],
  "RetCode": 0,
  "TotalCount": 7
}
```