检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API 激活管理
API概览 表1 CodeArts IDE 接口说明 分类 接口 激活管理 购买激活码 查询激活码列表 激活码绑定用户 激活码解绑用户
如何调用API 构造请求 认证鉴权 返回结果
FastAPI应用 使用此启动配置来运行FastAPI应用程序。该配置将执行“uvicorn”命令,启动一个运行您应用程序的uvicorn服务器。 启动配置属性 启动配置示例 父主题: 启动配置
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987
对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。 图1 获取用户Token响应消息头 响应消息体 响应消息体
由账号在IAM中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,您可以查看账号ID和用户ID。通常在调用API的鉴权过程中,您需要用到账号、用户和密码等信息。 区域(Region) 从地理位置和网络时延维度划分,同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。
种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 在构造请求中以调用获取用户Token接口为例说明了如何调用API。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token
购买激活码 功能介绍 购买激活码 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/licenses 请求参数 表1 请求Header参数 参数 是否必选
激活码解绑用户 功能介绍 激活码解绑用户 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/licenses/{id}/unbind-user 表1
终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同,CodeArts IDE的终端节点如表1所示,请您根据业务需要选择对应区域的终端节点。 表1 CodeArts IDE的终端节点 区域名称 区域 终端节点(Endpoint) 协议类型 华北-北京四 cn-north-4
激活码绑定用户 功能介绍 激活码绑定用户 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/licenses/{id}/bind-user 表1 路径参数
连接华为云,快速完成基于API的应用开发 内置华为云API开发套件,提供华为云200服务和8000+服务API的搜索和引用,一键引入样例代码,帮助开发者快捷使用华为云和高效开发华为云应用。 父主题: 产品特性
查询激活码列表 功能介绍 查询激活码列表 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/licenses 表1 Query参数 参数 是否必选 参数类型
激活管理 购买激活码 查询激活码列表 激活码绑定用户 激活码解绑用户 父主题: API
获取项目ID 调用API获取项目ID 项目ID还可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,可以从终端节点获取。接口的认证鉴权请参见认证鉴权。
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 鼠标悬停在右上角的用户名,在下拉列表中单击“我的凭证”。 进入“我的凭证 > API凭证”页面,即可查看账号ID。 图1 获取账号ID 父主题:
其中,error_code表示错误码,error_msg表示错误描述信息。 错误码说明 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 400 IDE.00000097 输入参数校验失败。
IDE是一个适用于Windows和Linux的集成开发环境(IDE),它将源代码编辑器的简洁性与代码补全和调试等强大的开发工具结合在一起,提供简单易用的编辑-构建-调试能力,可以让您在环境配置上花费更少的时间,节省更多的时间用于实现您的创意。 您可以使用本文档提供的API对CodeArts
附录 状态码 错误码 获取项目ID 获取账号ID