1. 标签列表

1.1. 描述

获取标签列表

1.2. 请求地址

请求地址的格式如下:

https://<区域服务地址>/v1/tag/list

1.3. 请求参数

Name Type Description Required
projectId String 项目ID
curPage Integer 当前页码,默认值1
perPage Integer 每页显示条数,默认值10

1.4. 请求示例

以查询华东一区某项目的标签列表为例:

1.4.1. 请求地址

POST https://cn-east-1.api.yovole.com/v1/tag/list HTTP/1.1
  x-ycs-timestamp: 2019-06-19T14:26:26Z
  x-ycs-requestid: 2a49cfa2-925b-11e9-bb3a-6c96cfdcd6b9
  x-ycs-security-authorization: Authorization: YCS1-HMAC-SHA1 Credential=08e206fb-7b41-45b7-8076-8d43e8aeea89,SignedHeaders=content-type;x-ycs-requestid;x-ycs-timestamp,Signature=2RFjU7C9gICCrQfpAIfAJHqRRlQ=

1.4.2. 接口请求参数

{
  "projectId": "8a83a0906b692378016b6d5ec5f40250",
  "curPage":1,
  "perPage":10
}

1.5. 返回结果示例

1.5.1. 返回正确结果示例

{
  "requestId": "43e31824-38cb-4be2-9e3a-86a90a98ae4f",
  "success": true,
  "code": 200,
  "message": null,
  "model": null,
  "pager": {
    "curPage": 1,
    "perPage": 10,
    "totalRecords": 3,
    "totalPages": 1,
    "pageData": [
      {
        "id": "f769458f-f048-4917-a6e3-0b3736d272b7",
        "name": "test",
        "style": "tag-1",
        "resCount": 3,        
    "created": "2021-07-19 10:37:06"
      }      
    ]
  }
}

1.5.2. 返回错误结果示例

{
  "requestId": "19c0e7ff-5554-4e90-b3a5-3aab644a8e30",
  "success": false,
  "code": 401,
  "message": "client enabled is false",
  "errorCode": "InvalidUserAccount"
}

1.6. 错误码

可以通过错误返回结果中的code、errorCode和message字段了解错误分类和具体的错误原因。

该接口没有特殊错误码,错误码信息和简单的错误分析方法可以参考公共错误码

results matching ""

    No results matching ""