autodl api

### Autodl API 使用指南 Autodl 是一种用于机器学习和深度学习任务的云端计算服务，提供了强大的 GPU 资源支持以及便捷的操作方式。为了更好地利用其功能，可以通过 API 实现自动化操作和管理资源。 #### 一、API 基础概述 Autodl 提供了一套 RESTful API 接口，允许开发者通过 HTTP 请求来管理和控制云服务器实例。这些接口涵盖了创建实例、启动/停止实例、查询状态等功能[^2]。 #### 二、获取 API 密钥 在使用 Autodl 的 API 功能之前，需要先登录到官方平台并生成个人专属的 API Key。具体步骤如下： 1. 登录 [Autodl 官网](https://www.autodl.com/home)[^3]。 2. 进入账户设置页面找到 API Keys 部分。 3. 创建一个新的密钥并将它妥善保存。 此 API Key 将作为身份验证的一部分，在后续所有的请求头中携带 `Authorization` 字段传递给服务器端。 #### 三、主要 API 列表及其用途说明 ##### 1. **创建新实例** 当需要新增一台虚拟机时可以调用该方法完成初始化工作。 - URL: `/api/v1/cloud-instances` - Method: POST - Headers: ```json { "Content-Type": "application/json", "Authorization": "<your_api_key>" } ``` - Body 参数示例 (JSON 格式): ```json { "name":"test_instance", "region":"us-west-1a", "gpu_type":"T4" } ``` ##### 2. **查看所有实例的状态** 如果想了解当前有哪些正在运行中的节点，则可通过这个 GET 方法检索列表数据。 - URL: `/api/v1/cloud-instances` - Method: GET - Headers 同上 返回结果会是一个 JSON 数组形式的数据结构，其中包含了每台主机的关键属性信息如 ID, 名字, 地区等等. ##### 3. **删除指定ID下的某个特定实例** 对于不再使用的旧项目来说及时清理掉对应的硬件分配是非常重要的行为之一. - URL: `/api/v1/cloud-instances/{instance_id}` - Method: DELETE - Headers 和路径参数 `{instance_id}` 替换为目标对象的实际编号. 以上仅列举了一些常用的功能点，更多细节可查阅官方文档获得完整的定义描述. ```python import requests def create_autodl_instance(api_key, name="default_name"): url = 'https://api.autodl.com/api/v1/cloud-instances' headers = {"Content-Type": "application/json", "Authorization": api_key} payload = {'name': name, 'region':'us-east', 'gpu_type':'V100'} response = requests.post(url, json=payload, headers=headers) if response.status_code == 200 or response.status_code == 201 : print('Instance created successfully.') else: print(f'Failed to create instance with status code {response.status_code}') create_autodl_instance('<Your_API_Key>') ``` 上述代码片段展示了如何基于 Python 编写一段简单的程序去远程建立新的计算单元.