API概览 表1 CodeArts IDE接口说明 分类 接口 激活管理 购买CodeArts IDE激活码 查询CodeArts IDE激活码列表 绑定激活码至指定用户 解绑已绑定的激活码
如何调用API 构造请求 认证鉴权 返回结果
连接华为云,快速完成基于API的应用开发 内置华为云API开发套件,提供华为云200服务和8000+服务API的搜索和引用,一键引入样例代码,帮助开发者快捷使用华为云和高效开发华为云应用。 父主题: 产品优势
API 激活管理
FastAPI应用 使用此启动配置来运行FastAPI应用程序。该配置将执行“uvicorn”命令,启动一个运行您应用程序的uvicorn服务器。 启动配置属性 启动配置示例 父主题: 启动配置
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。
Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 在构造请求中以调用获取用户Token接口为例说明了如何调用API。
获取项目ID 调用API获取项目ID 项目ID还可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,可以从终端节点获取。
错误码说明 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 400 IDE.00000097 输入参数校验失败。 输入参数校验失败。 检查输入参数格式。
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。
调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
激活管理 购买CodeArts IDE激活码 查询CodeArts IDE激活码列表 绑定激活码至指定用户 解绑已绑定的激活码 父主题: API
文档修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第一次正式发布。 2025-05-26
调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
附录 状态码 错误码 获取项目ID 获取账号ID
状态码 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTP的新版本协议。 201
对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
调用说明 CodeArts IDE提供了REST(Representational State Transfer)风格API,支持您通过HTTPS请求调用,调用方法请参见如何调用API。 您可以在API Explorer中调用API,查看API请求和返回结果。
您即将访问非华为云网站,请注意账号财产安全