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

获取ticket列表

功能介绍

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

URI

GET /v1/{project_id}/tickets

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

最小长度：0

最大长度：128
表2 Query参数

参数

是否必选

参数类型

描述

user_id

否

String

用户id。

最小长度：0

最大长度：100

user_name

否

String

用户名。

最小长度：0

最大长度：100

user_type

否

Integer

用户类型。

embed_id

否

String

嵌入分析id。

最小长度：0

最大长度：100

limit

否

Integer

返回条目数。不传该参数时，默认查询前10条信息。取值范围：[0,1000] 默认值：10。

最小值：0

最大值：1000

offset

否

Integer

返回条目的起始offset。取值范围：[0,1000] 默认值：0。

最小值：0

最大值：1000

sort_dir

否

String

是否降序。

最小长度：0

最大长度：128

sort_key

否

String

排序字段。

最小长度：0

最大长度：128

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：0

最大长度：8192

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

数据总条数。

page_data

Array of 表7-9 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管理

相关文档