华为云用户手册

  • URI GET /v2/projects/repositories 表1 Query参数 参数 是否必选 参数类型 描述 page_index 否 Integer 参数解释: 分页索引。 取值范围: 最小值:1 最大值:2147483647 默认取值: 1 page_size 否 Integer 参数解释: 每页条目数。 取值范围: 最小值:1 最大值:100 默认取值: 100 search 否 String 参数解释: 搜索关键字。 取值范围: 字符串长度不少于1,不超过512。 默认取值: 空。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 error Error object 参数解释: 接口调用时,响应错误。 取值范围: 无。 result RepoListInfoV2 object 参数解释: 接口调用的响应结果。 取值范围: 无。 status String 参数解释: 调用此接口的响应状态。 取值范围: success,表示接口调用成功。 failed,表示接口调用失败。 表4 Error 参数 参数类型 描述 code String 参数解释: 调用此接口失败时返回的错误码。 取值范围: CH.080002 message String 参数解释: 调用此接口失败时返回的错误码。 取值范围: CH.080002 参数错误。 表5 RepoListInfoV2 参数 参数类型 描述 repositories Array of RepoInfoV2 objects 参数解释: 返回的仓库列表。 total Integer 参数解释: 返回的仓库总数。 取值范围: 0-2147483647 表6 RepoInfoV2 参数 参数类型 描述 created_at String 参数解释: 创建时间。 约束限制: 格式: yyyy-MM-dd HH:mm:ss creator_name String 参数解释: 创建者的用户名。 取值范围: 只能为数字和字母,长度为128字符。 domain_name String 参数解释: 创建者的租户名。 取值范围: 只能为数字和字母,长度为128字符。 group_name String 参数解释: 仓库代码组名。 (克隆地址中 域名 后面仓库名前的一段。 示例:git@repo.alpha.devcloud.test.com:Demo00228/testword.git 代码组名:Demo00228 ) 取值范围: 字符串长度不少于2,不超过255。 https_url String 参数解释: HTTPS仓库地址。 取值范围: 字符串长度不少于0,不超过2000。 iam_user_uuid String 参数解释: 用户 IAM ID。 取值范围: 只能由数字和字母组成,且长度为32个字符。 is_owner Integer 参数解释: 是否是仓库的创建者。 取值范围: 1: 是创建者。 0: 不是创建者。 lfs_size String 参数解释: 仓库 LFS 容量。 约束限制: 单位M,或者G,保留2位小数。 project_is_deleted String 参数解释: 项目是否被删除。 取值范围: false: 项目没有删除。 true: 项目已经删除。 project_uuid String 参数解释: 项目ID,获取方式请参见获取项目ID。 取值范围: 只能由数字和字母组成,且长度为32个字符。 repository_id Integer 参数解释: 仓库ID。 取值范围: 只能由数字组成,且范围为0-2147483647。 repository_name String 参数解释: 仓库名。 取值范围: 字符串长度不少于2,不超过255。 repository_size String 参数解释: 仓库总容量 = 仓库LFS容量 + git库容量。 约束限制: 单位M,或者G,保留2为小数。 repository_uuid String 参数解释: 仓库UUID(由CreateRepository接口返回)。 约束限制: 只能由数字和字母组成,且长度为32个字符。 ssh_url String 参数解释: SSH仓库地址。 取值范围: 字符串长度不少于0,不超过2000。 star Boolean 参数解释: 当前用户是否收藏该仓库。 取值范围: false: 未收藏。 true: 已收藏。 status Integer 参数解释: 仓库状态。 取值范围: 0: 仓库正常创建成功。 1: 仓库创建中。 2: 创建失败。 3: 仓库冻结。 4: 仓库已经关闭。 updated_at String 参数解释: 更新时间。 约束限制: 格式: yyyy-MM-dd HH:mm:ss。 userRole Integer 参数解释: 用户在仓库中的角色。 约束限制: 20: 只读成员。 30: 普通成员 。 40: 管理员。 visibility_level Integer 参数解释: 仓库可见性。 取值范围: 0: 私有仓库。 20: 公有仓库。 web_url String 参数解释: web url 路径,访问它将跳转至仓库详情页。 取值范围: 字符串长度不少于0,不超过2000。
  • 响应示例 状态码: 200 OK { "result" : { "projects" : [ { "id" : 453613, "name" : "javaMavenDemo", "template_name" : "javaMavenDemo", "tags" : [ "UnsupportedPipeline", "OTHERS", "鲲鹏 ARM64" ], "description" : "javaMavenDemo", "brief_introduction" : "javaMavenDemo", "auto_pending_pipelines" : 0, "language" : "OTHERS", "created_at" : "Sep 25, 2019 4:03:31 PM", "used_times" : 58, "liked_times" : 1, "creator_name" : "Codehub", "https_url" : "https://codehub.alpha.devcloud.intest.com/chentest00001/javaMavenDemo.git" } ], "total" : 100 }, "status" : "success" }
  • URI GET /v1/repositories/repository_templates 表1 Query参数 参数 是否必选 参数类型 描述 platform 否 String 模板平台类型 language 否 String 语言类型 pipeline 否 String 是否支持流水线 entertype 否 String 模板分类 search 否 String 模板名称 dateorder 否 String 模板日期排序 usedtimeorder 否 String 模板引用次数排序 type 否 String 模板公开类型 region 否 String 大区名称 page_no 是 Integer 分页页数 page_size 是 Integer 每页数据数
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result TemplateRepositoryList object 响应结果 status String 响应状态 表4 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表5 TemplateRepositoryList 参数 参数类型 描述 projects Array of TemplateRepository objects 模板列表 total Integer 模板总数 表6 TemplateRepository 参数 参数类型 描述 id Integer 模板唯一标识 name String 模板名称 template_name String 模板关联仓库名称 tags Array of strings 模板标签 description String 模板描述 brief_introduction String 模板简介 auto_pending_pipelines Integer 是否自动创建流水线 language String 模板语言分类 created_at String 模板创建时间 used_times Integer 模板引用次数 liked_times Integer 模板被点赞次数 creator_name String 模板创建人 https_url String 模板https链接
  • 响应示例 状态码: 200 OK { "result" : { "id" : "85a0a9d5c6e43bc9c3e443ac01f789e24eeef02b", "title" : "some commit message", "message" : "some commit message", "short_id" : "85a0a9d5", "author_name" : "repo", "author_email" : null, "committer_name" : "repo", "committer_email" : null, "created_at" : "2021-09-26T03:44:51.000Z", "parent_ids" : [ "5c114bb316dff4d4a046e09a5c44c816f2433140" ], "committed_date" : "2021-09-26T03:44:51.000Z", "authored_date" : null, "stats" : { "additions" : 1, "deletions" : 0, "total" : 1 }, "last_pipeline" : { "id" : 292811, "sha" : "2202af08836f0afd762d1b151d15ac510b974bdf", "ref" : "master", "status" : "running", "web_url" : "https://test.com/Pipeline_Beta_sdcs00001/202107171926/pipelines/292811" } }, "status" : "success" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result SpecificCommitInfo object 响应结果 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 SpecificCommitInfo 参数 参数类型 描述 id String 提交对应的SHA id short_id String 提交对应的短SHA id title String 提交标题 author_name String 作者 author_email String 作者邮箱 committer_name String 提交作者 committer_email String 提交作者邮箱 created_at String 创建时间 message String 提交信息 parent_ids Array of strings 父提交id committed_date String 提交时间 authored_date String 作者提交时间 stats stats object 变更行数 last_pipeline last_pipeline object 流水线信息 表7 stats 参数 参数类型 描述 additions Integer 变更增加的行数 deletions Integer 变更删除的行数 total Integer 变更的总行数 表8 last_pipeline 参数 参数类型 描述 id Integer 流水线id sha String 提交对应的SHA id ref String 分支名 status String 流水线状态 web_url String 流水线url
  • URI GET /v2/projects/{repo_id}/repository/commits/{sha} 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 Integer 仓库短id sha 是 String commit id,仓库的branch名或tag名 表2 Query参数 参数 是否必选 参数类型 描述 stats 否 Boolean 包括提交统计信息。默认值为true
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 表2 请求Body参数 参数 是否必选 参数类型 描述 branch 是 String 分支名 project_id 是 String 项目ID,获取方式请参见获取项目ID。 related_id 是 Array of strings 工作项集合 repo_id 是 String 仓库id
  • 请求示例 POST https://{endpoint}/v2/projects/{project_uuid}/repositories/fork { "project_name" : "testworld", "repo_name" : "demotest1", "template_id" : 453489, "import_members" : 0, "visibility_level" : 20, "type" : "normal" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 参数解释: 响应错误。 result ProjectRepository object 参数解释: 响应结果。 status String 参数解释: 响应状态。 表5 Error 参数 参数类型 描述 code String 参数解释: 错误码。 message String 参数解释: 错误信息。 表6 ProjectRepository 参数 参数类型 描述 projectUuid String 参数解释: 项目ID,获取方式请参见获取项目ID。 取值范围: 最小长度:32 最大长度:32 repositoryUuid String 参数解释: 仓库UUID。 取值范围: 最小长度:32 最大长度:32
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 表2 请求Body参数 参数 是否必选 参数类型 描述 import_members 否 Integer 参数解释: 是否导入项目成员。 取值范围: 0,表示不导入项目成员 1,表示导入项目成员。 project_name 是 String 参数解释: 项目名称。 取值范围: 可以输入英文大小写字母、数字、连字符、下划线,且必须以字母开头。 repo_name 是 String 参数解释: 仓库名称。 取值范围: 可以输入英文大小写字母、数字、连字符、下划线,且必须以字母开头。 最小长度:2 最大长度:128 template_id 是 String 参数解释: 复制模板的ID。 type 否 String 参数解释: 项目类型,scrum。 visibility_level 否 Integer 参数解释: 仓库可见性。 约束限制: 不涉及。 取值范围: 私有仓库:仓库仅对仓库成员可见,仓库成员可读写和访问仓库,取值为0 公开仓库: 项目内成员只读仓库:仓库对项目内成员公开只读,并项目内成员可在项目下和代码组下的仓库列表中查看和搜索,取值为10 租户内成员只读仓库:仓库对租户内成员公开只读,并租户内成员可在项目下和代码组下的仓库列表中查看和搜索,取值为10 所有访客只读仓库:仓库对所有访客公开只读,并所有访客可在项目下和代码组下的仓库列表中查看和搜索,取值为20 默认取值: 0 external_project_info 否 ExternalKeyMessage object 参数解释: 第三方服务信息。 表3 ExternalKeyMessage 参数 是否必选 参数类型 描述 external_key_message 否 String 参数解释: 第三方保存在代码托管的关键信息。 external_service 否 String 参数解释: 外部服务名称。
  • 响应示例 状态码: 200 OK { "result" : { "total" : 2, "users" : [ { "user_id" : "5836", "name" : "repo", "domain_name" : "repo", "description" : null, "enabled" : null, "role" : 40, "domain_id" : "159b65b41ead484d8ddff250a4731781", "email" : null }, { "user_id" : "6057", "name" : "repo", "domain_name" : "repo", "description" : null, "enabled" : null, "role" : 30, "domain_id" : "159b65b41ead484d8ddff250a4731781", "email" : null } ] }, "status" : "success" }
  • URI GET /v1/repositories/{repository_uuid}/members 表1 路径参数 参数 是否必选 参数类型 描述 repository_uuid 是 String 参数解释: 仓库UUID(由CreateRepository接口返回) 约束限制: 必传。 取值范围: 可包含数字、字母,长度32位。 默认取值: 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 page_index 否 Integer 参数解释: 第几页。 约束限制: 不涉及。 取值范围: 数字。 默认取值: 不涉及。 page_size 否 Integer 参数解释: 每页显示size。 约束限制: 不涉及。 取值范围: 数字。 默认取值: 不涉及。 subject 否 String 参数解释: 搜索关键字,模糊匹配用户名称、用户昵称、租户名称。 约束限制: 不涉及。 取值范围: 长度限制128个字符。 默认取值: 不涉及。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result Array of FileContentInfo objects 差异列表 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 FileContentInfo 参数 参数类型 描述 file_name String 文件名 file_path String 文件路径 size Integer 文件大小 encoding String 文件编码 content_sha256 String sha256编码的文件内容 ref String 分支名 blob_id String blob sha commit_id String 提交对应的SHA id last_commit_id String 最后一个提交对应的SHA id content String base64编码的文件内容
  • 响应示例 状态码: 200 OK { "result" : [ { "size" : 9, "encoding" : "base64", "ref" : "master", "content" : "NDU0NTQ1NDQ1", "file_name" : "README.md", "file_path" : "README.md", "content_sha256" : "e16f4f6c41a79d120484774a625bea8a3c3dcb655aa7c7e793ac48639dc63944", "blob_id" : "3325fa3142fd66fedc8c3a5218b417f561e0ea2f", "commit_id" : "a772945ec2765e322cc83e0f467f394effa22cf3", "last_commit_id" : "a772945ec2765e322cc83e0f467f394effa22cf3" } ], "status" : "success" }
  • URI GET /v2/projects/{repo_id}/repository/files/{file_path} 表1 路径参数 参数 是否必选 参数类型 描述 repo_id 是 Integer 仓库短id file_path 是 String Url编码的新文件的完整路径。 表2 Query参数 参数 是否必选 参数类型 描述 ref 是 String commit id,仓库的branch名或tag名
  • 状态码 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTP的新版本协议。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求,但未处理完成。 203 Non-Authoritative Information 非授权信息,请求成功。 204 NoContent 请求完全成功,同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容,服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置,相应可返回一个资源特征与地址的列表用于用户终端(例如:浏览器)选择。 301 Moved Permanently 永久移动,请求的资源已被永久的移动到新的URI,返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改,服务器返回此状态码时,不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求,不要重试该请求。 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求,不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求,不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证,与401类似,但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码,表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大,服务器无法处理,因此拒绝请求。为防止客户端的连续请求,服务器可能会关闭连接。如果只是服务器暂时无法处理,则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长(URI通常为网址),服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确,但是由于含有语义错误,无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部,然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能,无法完成请求。 502 Bad Gateway 充当网关或代理的服务器,从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求,不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时(Timeout)参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本,无法完成处理。 父主题: 附录
  • 请求示例 POST https://{endpoint}/v2/repositories/{repository_id}/deploy-keys { "key_title" : "repo@huawei.com", "key" : "ssh-rsa AAAAB3NzaC1yc2EA*********************************************************U7xcma6HU8nj1E0i46VObWyOONl3gh142BV repo@huawei.com", "can_push" : true, "application" : "" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result Key object 响应结果 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 Key 参数 参数类型 描述 can_push Boolean 是否允许推送 created_at String 部署密钥新建时间 key String 部署密钥 key_id String 部署密钥id 最小长度:1 最大长度:40 key_title String 部署密钥名称
  • 响应示例 状态码: 200 OK { "result" : { "key_id" : "1034546", "key_title" : "repo@huawei.com", "key" : "ssh-rsa AAAAB3NzaC1yc2EA*********************************************************U7xcma6HU8nj1E0i46VObWyOONl3gh142BV repo@huawei.com" }, "status" : "success" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 application 是 String 部署使用的SSH密钥的来源 can_push 是 Boolean 部署使用的SSH密钥是否可以推送代码 key 是 String 部署使用的SSH密钥 key_title 是 String 部署使用的SSH密钥名称
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result TemplateListInfo object 响应结果 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 TemplateListInfo 参数 参数类型 描述 repos Array of DevstarRepoInfo objects 仓库列表 total_count Integer 仓库总数 表7 DevstarRepoInfo 参数 参数类型 描述 uuid String 仓库的uuid repo_id String 仓库ID repo_name String 仓库名称 ssh_url String 仓库SSH地址 code_url String 仓库HTTPS地址 detail_url String 仓库预览地址
  • 响应示例 状态码: 200 OK { "result" : { "repos" : [ { "uuid" : "36f532939c4b4e2191c10f5353ccf34c", "repo_id" : 487773, "repo_name" : "DDDDDDDD", "ssh_url" : "git@codehub.alpha.devcloud.intest.com:CHEN_TEST00001/DDDDDDDD.git", "code_url" : "https://codehub.alpha.devcloud.intest.com/CHEN_TEST00001/DDDDDDDD.git", "detail_url" : "https://alpha.devcloud.intest.com/codehub/487773/home" } ], "total_count" : 100 }, "status" : "success" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 参数解释: 创建保护Tag规则,在产品界面对应“Tag名称”。 约束限制: 不涉及。 取值范围: 保护Tag规则不能包含空格,且长度为[1-500]个字符。 默认取值: 不涉及。 create_access_level 否 Integer 参数解释: 保护Tag创建权限。 约束限制: 不涉及。 取值范围: 0,表示不允许任何人创建符合此规则的Tag。 30,表示开发人员、Committer、项目经理和管理员可创建符合此规则的Tag。 40,项目经理和管理员可修改或删除此符合规则的Tag。 默认取值: 不涉及。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 参数解释: 响应错误。 result AddProtectTagResponse object 参数解释: 响应结果。 status String 参数解释: 响应状态。 取值范围: success,表示“新建保护Tag”成功。 fail,表示“新建保护Tag”失败。 表5 Error 参数 参数类型 描述 code String 参数解释: 错误码。 取值范围: 请参见错误码。 message String 参数解释: 错误信息。 取值范围: 字符串。 表6 AddProtectTagResponse 参数 参数类型 描述 name String 参数解释 保护Tag规则,在产品界面对应“Tag名称”。 取值范围: 字符串长度范围为[1,500]个字符。 create_access_levels CreateAccessLevels object 参数解释: 保护Tag的权限。 表7 CreateAccessLevels 参数 参数类型 描述 access_level Integer 参数解释: 可创建此Tag规则的权限。 取值范围: 0,不允许任何人创建此规则的Tag。 30,开发人员、Committer、项目经理和管理员创建此规则的Tag。 40,项目经理、管理员可创建此规则的Tag。 access_level_description String 参数解释: 权限描述 取值范围: “Maintainers”, 项目经理、管理员。 “Developers + Committer + Maintainers”, 开发人员、Committer、项目经理和管理员。 “No one”, 不允许任何人。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 pwd 是 String 参数解释: https密码。 约束限制: 长度为8-32位; 数字、大写字母、小写字母及特殊字符至少包含三种,不能与用户名或者倒序的用户名相同!
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 error Error object 参数解释: 接口调用时,响应错误。 取值范围: 无。 result String 参数解释: 接口调用的响应结果。 取值范围: verificationPassed:密码正确 status String 参数解释: 调用此接口的响应状态。 取值范围: success,表示接口调用成功。 failed,表示接口调用失败。 表5 Error 参数 参数类型 描述 code String 参数解释: 调用此接口失败时返回的错误码。 取值范围: CH.080002 CH.010112 CH.010008 message String 参数解释: 调用此接口失败时返回的错误码。 取值范围: password格式不正确。 用户不存在。 输入密码不正确。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result TagList object 响应结果 status String 响应状态 表4 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表5 TagList 参数 参数类型 描述 tags Array of Tag objects 指定仓库的标签列表 total Integer 指定仓库的标签总数 表6 Tag 参数 参数类型 描述 is_double_name Boolean 是否与分支重名 name String 标签名 最小长度:1 最大长度:260
  • 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于获取用户Token接口,返回如下消息体。为篇幅起见,这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "cn-north-1", ...... 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001" } 其中,error_code表示错误码,error_msg表示错误描述信息。
共100000条