华为云用户手册

  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 x-auth-token 是 String iam x-auth-token 表2 请求Body参数 参数 是否必选 参数类型 描述 region 否 String the region of user name 否 String the name of user email 否 String the email of user organization 否 String the organization of user phone_number 否 String the phone_number of user invitation_code 否 String the invitation_code
  • 请求示例 创建一个地域在北京,用户名为“name”,邮箱为“email@codeartssnap.com”,组织为“huawei”的用户。 POST https://{endpoint}/v2/aims/codemodelserver/join-request{ "region" : "北京", "name" : "name", "email" : "email@codeartssnap.com", "organization" : "huawei", "phone_number" : "13666666666", "invitation_code" : "gouliguojiashengsiyi"}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 result Object 返回值 status String 状态 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 result Boolean 返回值 status String 状态 状态码: 403 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 404 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 406 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 request_id String the unique id of the request status String the status of the request 枚举值: created dispatched completed timeout unknown dispatched_task_number Integer the number of tasks dispatched successfully
  • 请求示例 创建一个签名为“def add(x, y):”、语言为“python”、文档字符串为“sum two numbers”的代码生成请求。 POST https://{endpoint}/v2/aims/codemodelserver/code-generation/request{ "signature" : "def add(x, y):", "language" : "python", "docstring" : "sum two numbers", "context" : " return x + y", "ide_type" : "pycharm professional", "ide_version" : "2022.1.3", "plugin_version" : "v0.1.0"}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 x-auth-token 是 String iam x-auth-token 表3 请求Body参数 参数 是否必选 参数类型 描述 context 否 String context docstring 否 String docstring ide_type 否 String the type of ide ide_version 否 String the version of ide language 是 String code language plugin_version 否 String the version of plugin signature 否 String signature above_text 否 String the text above the cursor following_text 否 String the text following the cursor
  • URI POST /v2/aims/codemodelserver/code-generation/request 表1 Query参数 参数 是否必选 参数类型 描述 topn 否 Integer the number of samples scenario 否 String the scenario of code content resubmit 否 Boolean if resubmit is true, the de-duplication will be ignored model_id 否 String choose the model request_type 否 String An enumeration. function rawtext 枚举值: function rawtext
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 result Object 返回值 status String 状态 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 功能介绍 create a code generation request.if agent receives a code generation request, it will:- record the request into mysql,- decompose the request into topn tasks.- send the tasks to kafka.if agent receives a duplicated code generation request, it will not decompose request and send to kafka.
  • 请求示例 创建IDE实例 POST https://{endpoint}/v2/6251b1ee539f4c02ad4b83daeda81633/instances{ "display_name" : "testjava", "stack_id" : "java", "description" : "", "cpu_memory" : "2U4G", "pvc_quantity" : "5GB", "refresh_interval" : "30"}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result result object 返回值 status String 状态 表5 result 参数 参数类型 描述 link String 链接 arch String cpu架构 x86|arm 枚举值: x86 arm id String 实例id private Boolean 是否私有平台 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 404 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 406 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 result Object 返回值 status String 状态 状态码: 401 表3 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 403 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 404 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 请求示例 举报评论ID为"353"内容为"重复评论"。 POST https://{endpoint}/v1/marketplace/extension/evaluation/accusation{ "evaluation_id" : "353", "content" : "重复评论"} 举报回复ID为"123"的回复为“违规内容”。 POST https://{endpoint}/v1/marketplace/extension/evaluation/accusation{ "reply_id" : "123", "content" : "违规内容"}
  • 请求示例 创建名为“testjava”、Java技术栈、CPU规格为“2U4G”、PVC规则为“5GB”、自动休眠时长为30分钟、不在页面显示,用户ID和租户ID为“test”的实例。 POST https://{endpoint}/v2/instances{ "instance_name" : "testjava", "stack_id" : "java", "description" : "", "cpu_memory" : "2U4G", "pvc_quantity" : "5GB", "refresh_time" : "30", "is_temporary" : false, "instance_user_id" : "test", "instance_user_domain_id" : "test"}
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 result result object 返回值 status String 状态 表6 result 参数 参数类型 描述 link String 链接 arch String cpu架构 x86|arm 枚举值: x86 arm id String 实例id private Boolean 是否私有平台 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 406 表9 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 arch 否 String cpu架构 x86|arm 枚举值: x86 arm cpu_memory 是 String cpu规格.arm架构支持4U8G,x86架构支持1U1G,2U4G,2U8G 与技术栈配置的规格对应,可通过技术栈管理ListStacks接口获取。如果标签不为空,以标签配置的技术栈规格为准。 quantum技术栈,x86架构cpu规格为2U8G;其他技术栈,x86架构cpu规格为1U1G,2U4G 枚举值: 1U1G 2U4G 2U8G 4U8G description 否 String 描述。长度不超过100个字符 instance_name 是 String 实例名。 可以输入中文、数字、字母、下划线、点、破折号。长度介于3-100之间 instance_user_domain_id 否 String 租户id(对应华为云账号的domainId) instance_user_id 否 String 用户id is_temporary 否 Boolean 是否页面显示(以标签配置为准) plugins 否 Array of Plugin objects 插件列表 pvc_quantity 是 String PVC规格 5GB|10GB|20GB 枚举值: 5GB 10GB 20GB refresh_time 否 String 自动休眠时长。arm架构,自动休眠时长只能设置成30,60。x86架构可取值为30,60,240,1440和-1。除-1外,其它值的单位为“分钟”。实例无操作超过自动休眠时长后,将会被暂停(已保存的数据不会被删除)。-1表示实例不会自动停止。 stack_id 是 String 技术栈ID,通过技术栈管理ListStacks接口获取。 表4 Plugin 参数 是否必选 参数类型 描述 attribute 否 String 插件属性 name 否 String 插件名
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 result Boolean 返回值 status String 状态 状态码: 403 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 404 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 406 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 请求示例 创建一个“pycharm”类型,IDE版本为“Professional Edition 2022.1”的登录。 POST https://{endpoint}/v2/aims/codemodelserver/code-generation/login{ "ide_type" : "pycharm", "ide_version" : "Professional Edition 2022.1", "plugin_version" : "v1.0.0"}
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 x-auth-token 是 String iam x-auth-token 表2 请求Body参数 参数 是否必选 参数类型 描述 ide_type 是 String ide_type ide_version 是 String ide_version plugin_version 是 String plugin_version
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表2 请求Body参数 参数 是否必选 参数类型 描述 evaluation_id 否 String 所在评论id reply_id 否 String 回复评论的id 空表示回复主评论 text 是 String 评论或回复内容
  • 请求示例 回复评论ID为354的评论“回复评价” POST https://{endpoint}/v1/marketplace/extension/evaluation/reply{ "evaluation_id" : "354", "text" : "回复评价"} 回复回复评论ID为123的内容“回复评论回复”。 POST https://{endpoint}/v1/marketplace/extension/evaluation/reply{ "reply_id" : "123", "text" : "回复评论回复"}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 result Object 返回值 status String 状态 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 x-auth-token 是 String iam x-auth-token 表2 请求Body参数 参数 是否必选 参数类型 描述 component 是 String the component of the codearts snap verb 否 String the verb of the action object 否 String the the object of the verb data 否 Object the data of the event
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 x-auth-token 是 String iam x-auth-token Content-Type 否 String content enumeration - application/json 枚举值: application/json 表2 请求Body参数 参数 是否必选 参数类型 描述 result_id 是 String request id
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 extension_version 是 String 插件版本 identifier 是 String 插件标识(发布者.插件名) instance_id 否 String CodeArtsIDEOnline实例ID status 是 String 插件状态。 AGREE 同意 REJECT 不同意 UNKNOWN 未知(下次重新询问) 枚举值: AGREE REJECT UNKNOWN
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result Boolean 返回值 status String 状态 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 406 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
  • 响应示例 状态码: 200 OK { "result" : true, "status" : "success"} 状态码: 403 Forbidden { "error_code" : "IDE.00010129", "error_msg" : "Instance does not belong to the user or tenant"} 状态码: 404 Not Found { "error_code" : "IDE.00010030", "error_msg" : "instance not exist"}
  • 请求示例 为插件ID为“07390271-f87f-4b98-9d72-3ad8ac541f52”的插件添加评论“给你一个评论”。 POST https://{endpoint}/v1/marketplace/extension/evaluation{ "extension_id" : "07390271-f87f-4b98-9d72-3ad8ac541f52", "text" : "给你一个评论"}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 result Boolean 返回值 status String 状态 状态码: 403 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 404 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 406 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误描述 error_code String 错误码
共99354条