查询实践案例 - ListNotebookPractices

功能介绍

查询实践案例接口用于租户侧前端获取Notebook实践案例列表。该接口适用于以下场景：当用户需要查看或学习Notebook实践案例时，可以通过此接口获取案例列表。使用该接口的前提条件是用户已登录且具有查看权限。查询操作完成后，接口将返回实践案例列表，包括案例名称、描述和相关标签等信息。若用户无权限或查询过程中出现其他异常，接口将返回相应的错误信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/notebooks/practices

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：用户项目ID。获取方法请参见获取项目ID和名称。约束限制：1 - 64字符，字母、数字和中划线。取值范围：不涉及。默认取值：不涉及。

表2 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	参数解释：指定每一页返回的最大条目数。约束限制：不涉及。取值范围：[1,100]。默认取值：10。
offset	否	Integer	参数解释：偏移量，表示从此偏移量开始查询。约束限制：不涉及。取值范围：[0,1000000000]。默认取值：0。
practice_id	否	String	参数解释：该参数为实践案例的id 约束限制：案例id为UUID，需满足正则“^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$” 取值范围：不涉及默认取值：不涉及
sort_key	否	String	参数解释：排序的字段，多个字段使用(“,”)逗号分隔。约束限制：不涉及。取值范围：长度限制为128个字符，支持大小写字母、数字、中划线、下划线和逗号。默认取值：不涉及。
sort_dir	否	String	参数解释：实例排序方式。约束限制：不涉及。取值范围：枚举类型，取值如下： ASC：升序 DESC：降序默认取值：DESC。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Language	是	String	参数解释：指定当前接口调用时的语言环境。约束限制：该请求头作为必填参数时，只用于依赖于国际化信息的接口。取值范围：不涉及。默认取值：不涉及。
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
data	Array of data objects	参数解释：实践案例数据。

表5 data
参数	参数类型	描述
image_id	String	参数解释：案例推荐使用的镜像id。取值范围：不涉及。
practice_id	String	参数解释：案例id。取值范围：不涉及。
shared_url	String	参数解释：案例使用的ipynb在obs桶的url(base64编码)。取值范围：不涉及。
status	String	参数解释：案例的启用状态。取值范围：不涉及。
title	String	参数解释：案例标题。取值范围：不涉及。