文档首页/智能数据洞察 DataArts Insight/API参考/Ticket管理/获取ticket列表 - ListTickets
更新时间：2025-11-25 GMT+08:00
查看PDF
分享

获取ticket列表 - ListTickets

功能介绍

获取Ticket列表。注意结果仅返回还在有效期内的Ticket列表。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/tickets

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。获取方法请参见获取项目ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

user_id

否

String

参数解释：

用户id。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

user_name

否

String

参数解释：

用户名。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

user_type

否

Integer

参数解释：

用户类型。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

embed_id

否

String

参数解释：

嵌入分析id。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

limit

否

Integer

参数解释：

返回条目数。

约束限制：

不涉及

取值范围：

[1,1000]

默认取值：

10

offset

否

Integer

参数解释：

分页查询偏移量。

约束限制：

不涉及

取值范围：

[0,1000]

默认取值：

0

sort_dir

否

String

参数解释：

排序类型。

约束限制：

不涉及

取值范围：

  • asc: 升序

  • desc: 降序

默认取值：

asc

sort_key

否

String

参数解释：

排序字段。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

count

Integer

参数解释：

数据总条数。

取值范围：

不涉及

page_data

Array of TicketVo objects

当前页的分页数据。

表5 TicketVo

参数

参数类型

描述

ticket

String

参数解释：

ticket。

取值范围：

不涉及

embed_id

String

参数解释：

ticket绑定的嵌入分析id。

取值范围：

不涉及

expire_time

String

参数解释：

ticket过期时间。

取值范围：

不涉及

left_num

String

参数解释：

ticket剩余使用次数。

取值范围：

不涉及

user_id

String

参数解释：

ticket绑定的用户id。

取值范围：

不涉及

user_name

String

参数解释：

ticket绑定的用户的用户名。

取值范围：

不涉及

user_type

String

参数解释：

ticket绑定的用户的用户类型。

取值范围：

不涉及

group_ids

Array of strings

参数解释：

ticket绑定的用户组id。

取值范围：

不涉及

请求示例

请求ticket列表。

GET https://{endpoint}/v1/{project_id}/tickets

响应示例

状态码：200

获取ticket列表成功。

{
    "count": 2,
    "page_data": [
        {
            "ticket": "848803f514dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "embed_id": "3577e712-xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "expire_time": "2024-08-26 20:48:52 (GMT+08:00)",
            "left_num": 1000,
            "user_id": "aaa18eb1xxxxxxx",
            "user_name": "user_a",
            "user_type": "IAM",
            "group_ids": []
        },
        {
            "ticket": "22a01f2f8cxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "embed_id": "3577e712xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "expire_time": "2024-08-26 20:48:45 (GMT+08:00)",
            "left_num": 1000,
            "user_id": "16246eaxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "user_name": "user_b",
            "user_type": "IAM",
            "group_ids": []
        }
}

状态码

状态码

描述

200

获取ticket列表成功。

错误码

请参见错误码。

父主题：Ticket管理

相关文档