帮你快速理解、总结文档立即下载
文档中心>API 中心>数据湖计算 DLC>AI DLC 案例广场相关接口>获取案例管理详情

获取案例管理详情

最近更新时间：2026-08-04 01:50:01

我的收藏

本页目录：

1. 接口描述

接口请求域名： dlc.tencentcloudapi.com 。

根据 exampleId 获取单个案例详情

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：GetExampleDetail。
Version 是 String 公共参数，本接口取值：2021-01-25。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。
ExampleId 是 String

案例ID


示例值：example-001-ray-core-basics

3. 输出参数

参数名称 类型 描述
Id Integer

ID


示例值：11
ExampleId String

案例ID


示例值：example-001-ray-core-basics
Title String

标题


示例值：Ray入门，你的第一个分布式作业
Description String

描述


示例值：通过简单案例快速掌握Ray的三大核心概念：Task、Actor和Object
Readme String

README


示例值：# Ray Hello World：5 分钟掌握分布式计算三大核心原语本案例是 Ray 案例广场的 Hello World。只需 5 分钟，通过交互式 Notebook 快速掌握 Ray 的三大核心原语
CodeArchiveUrl String

案例归档URL


示例值：https://common-job-packages-251233710.cos.ap-guangzhou.myqcloud.com/models/examples/example-001-ray-core-basics.zip
Image String

图片URL


示例值：ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu
LabImage String

实验室镜像


示例值：ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu-lab
ResourceConfig String

资源配置


示例值：{"Head":{"Name":"default-head","PodCpu":4,"PodMem":2,"PodNum":1},"Worker":[{"Name":"default-worker","PodCpu":1,"PodMem":2,"MinPodNum":4,"MaxPodNum":4}]}
Category String

分类


示例值：quickstart
Tags Array of String

案例标签


示例值：["Ray Core"]
Difficulty String

难度


示例值：beginner
EstimatedTime Integer

预估时间（分钟）


示例值：15
SortOrder Integer

排序


示例值：1
IsEnabled Boolean

是否启用


示例值：true
CreateTime Integer

创建时间


示例值：1779799361632
UpdateTime Integer

更新时间


示例值：1779799361632
Deleted Integer

是否删除


示例值：0
Popularity Integer

案例热度


示例值：12
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 GetExampleDetail

获取

输入示例

POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetExampleDetail
<公共请求参数>

{
    "ExampleId": "example-001-ray-core-basics"
}

输出示例

{
    "Response": {
        "Category": "quickstart",
        "CodeArchiveUrl": "https://common-job-packages-251233710.cos.ap-guangzhou.myqcloud.com/models/examples/example-001-ray-core-basics.zip",
        "CreateTime": 1779799361632,
        "Deleted": 0,
        "Description": "通过简单案例快速掌握Ray的三大核心概念：Task、Actor和Object",
        "Difficulty": "beginner",
        "EstimatedTime": 15,
        "ExampleId": "example-001-ray-core-basics",
        "Id": 11,
        "Image": "ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu",
        "IsEnabled": true,
        "LabImage": "ccr.ccs.tencentyun.com/emr-image/tcray:2.55.1-py311-cpu-lab",
        "Popularity": 12,
        "Readme": "# Ray Hello World：5 分钟掌握分布式计算三大核心原语\n\n本案例是 Ray 案例广场的 **Hello World**。只需 5 分钟，通过交互式 Notebook 快速掌握 Ray 的三大核心原语——**Task**（异步任务）、**Actor**（有状态服务）与 **Object**（分布式对象）。\n\n## 一、案例概览\n\n| 维度 | 说明 |\n| --- | --- |\n| 目标人群 | 刚接触分布式计算的开发者、数据科学家、系统架构师 |\n| 核心价值 | Ray 像是 Python 的“超级并发库”——无需学习 MPI 等底层通信框架，只需在函数或类上添加 `@ray.remote`，即可将单机代码无缝扩展到集群 |\n| 学习成本 | 代码改动量通常 < 5%，即可获得接近线性的水平扩展能力 |\n\n## 二、三大核心原语\n\n在 Ray 的世界里，只需掌握以下三个原语，就能构建从简单脚本到复杂分布式系统的各类应用：\n\n
mermaid\ngraph LR\n A["@ray.remote
装饰器"] --> B["Task
异步任务"]\n A --> C["Actor
有状态服务"]\n A --> D["Object
分布式对象"]\n

\n\n### 1. Task —— 异步任务\n\n将普通 Python 函数变为可在集群任意节点上运行的 **异步任务**。\n\n| 特性 | 说明 |\n| --- | --- |\n| 无状态 | 每次调用相互独立，天然适合并行 |\n| 异步调用 | 调用后立即返回 `ObjectRef`，不阻塞主线程 |\n| 典型场景 | 并行数据处理、大规模数值计算、蒙特卡洛模拟 |\n\n### 2. Actor —— 有状态服务\n\n将 Python 类变为运行在集群中的 **有状态服务进程**。\n\n| 特性 | 说明 |\n| --- | --- |\n| 有状态 | 在多次调用之间保持内部状态（如模型权重、计数器） |\n| 串行执行 | 同一 Actor 的方法调用按序执行，保证状态一致性 |\n| 典型场景 | 模型推理服务、参数服务器、数据库连接池、强化学习环境 |\n\n### 3. Object —— 分布式对象\n\nRay 基于底层 **Plasma Object Store** 提供高效的跨进程数据共享：\n\n| API | 功能 |\n| --- | --- |\n| `ray.put(obj)` | 将数据放入共享内存，返回 `ObjectRef`（引用 ID） |\n| `ray.get(ref)` | 根据引用 ID 取回数据 |\n\n> **性能亮点**：同一节点上的 Worker 可通过 **零拷贝（Zero-Copy）** 直接访问数据，大对象（矩阵、图片等）的传递效率极高。\n\n## 三、快速上手\n\n点击右上角 **“立即启动”** 按钮，即可进入预置好的 Jupyter Notebook 环境。以下是核心代码片段：\n\n### Step 1：初始化 Ray\n\n

python\nimport ray\n\nif not ray.is_initialized():\n ray.init()\nprint(f"集群资源: {ray.cluster_resources()}")\n

\n\n### Step 2：体验 Task（异步任务）\n\n将一个简单的平方计算函数变为分布式任务，4 个任务并行执行，耗时约 1 秒（串行需 4 秒）：\n\n

python\n@ray.remote\ndef square(x):\n time.sleep(1)\n return x * x\n\nfutures = [square.remote(i) for i in range(4)] # 并行提交\nresults = ray.get(futures) # 阻塞获取结果\n

\n\n### Step 3：体验 Actor（有状态服务）\n\n创建一个分布式计数器，即使并发调用也能保证状态一致：\n\n

python\n@ray.remote\nclass Counter:\n def init(self):\n self.count = 0\n\n def increment(self):\n self.count += 1\n return self.count\n\ncounter = Counter.remote()\nfutures = [counter.increment.remote() for _ in range(10)]\nprint(ray.get(futures)) # [1, 2, 3, ..., 10]\n

\n\n### Step 4：体验 Object（共享内存）\n\n将大数组放入共享内存，多个 Task 可零拷贝访问同一份数据：\n\n

python\nimport numpy as np\n\nlarge_array = np.random.rand(1000, 1000)\nobj_ref = ray.put(large_array) # 放入对象存储\n\n@ray.remote\ndef sum_array(arr):\n return arr.sum()\n\nresult = ray.get(sum_array.remote(obj_ref)) # 零拷贝读取\n

\n\n## 四、核心概念速查表\n\n| 概念 | 本质 | 关键 API | 状态 |\n| --- | --- | --- | --- |\n| **Task** | 远程函数 | `@ray.remote` → `.remote()` → `ray.get()` | 无状态 |\n| **Actor** | 远程类 | `@ray.remote` (类) → `.remote()` → `ray.get()` | 有状态 |\n| **Object** | 共享内存 | `ray.put()` → `ray.get()` | — |\n\n## 五、延伸阅读\n\n- [Ray Core 官方文档](https://docs.ray.io/en/latest/ray-core/walkthrough.html) — 完整 API 参考与进阶指南\n- [Ray 设计模式](https://docs.ray.io/en/latest/ray-core/patterns/index.html) — 常见分布式编程模式与最佳实践\n", "ResourceConfig": "{\"Head\":{\"Name\":\"default-head\",\"PodCpu\":4,\"PodMem\":2,\"PodNum\":1},\"Worker\":[{\"Name\":\"default-worker\",\"PodCpu\":1,\"PodMem\":2,\"MinPodNum\":4,\"MaxPodNum\":4}]}", "SortOrder": 1, "Tags": [ "Ray Core" ], "Title": "Ray入门，你的第一个分布式作业", "UpdateTime": 1779799361632, "RequestId": "080d3154-74fe-491d-862c-41bb43161735" } }

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation.Example 案例服务请求失败
FailedOperation.ExampleNotFound 案例不存在
中国站