华为云用户手册

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12M以内，12M以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

响应参数 状态码： 200 表3 响应Header 参数 参数类型 描述 X-Total String 当前请求的结果总条数 表4 响应Body参数(array) 参数 参数类型 描述 id String 关联结果 user_id Integer 用户ID domain_id String 租户ID ip_range String Ip范围 ip_type Integer 格式类型，指定IP，IP范围，CIDR ip_start String 起始IP ip_end String 结束IP view_flag Integer 是否允许访问代码仓库 download_flag Integer 是否允许下载代码 upload_flag Integer 是否允许提交代码 remark String 备注 created_at String 创建时间 updated_at String 更新时间 order_flag Integer 排序 表5 Error 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

响应示例 状态码： 200 OK [ { "id": "58119", "remark": "", "ip_range": "2.2.2.5", "ip_type": 0, "ip_start": "2.2.2.5", "ip_end": "2.2.2.5", "view_flag": 1, "download_flag": 1, "upload_flag": 1, "created_at": "Nov 6, 2024 4:58:05 PM", "updated_at": "Nov 6, 2024 4:58:05 PM", "order_flag": 1, "user_id": 7574, "domain_id": "********************************" }]

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result CommitStatistic object 代码增加和删除的行数 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 CommitStatistic 参数 参数类型 描述 additions Integer 增加的行数 deletions Integer 删除的行数

URI GET /v3/repositories/{repository_id}/commit-lines 表1 路径参数 参数 是否必选 参数类型 描述 repository_id 是 Integer 仓库短id 表2 Query参数 参数 是否必选 参数类型 描述 ref_name 是 String 分支名称 begin_date 是 String 起始提交日期,格式为yyyy-MM-dd end_date 是 String 终止提交日期,格式为yyyy-MM-dd（begin_date和end_date时间间隔不超过60天）

响应参数 状态码： 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格式不正确 用户不存在 输入密码不正确

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 必传。 取值范围： 字符串长度不少于1，不超过10万。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 pwd 是 String 参数解释： https密码 约束限制： 长度为8-32位; 数字、大写字母、小写字母及特殊字符至少包含三种，不能与用户名或者倒序的用户名相同!

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中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表示错误描述信息。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result RepoStatisticsLaunch object 响应结果 status String 响应状态 表5 Error 参数 参数类型 描述 code String 错误码 message String 错误信息 表6 RepoStatisticsLaunch 参数 参数类型 描述 can_statistics Boolean 仓库是否可以统计 join_id String sidekiq任务的 id message String 启动仓库统计返回的信息

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 不涉及。 取值范围： 长度为[1,100000]个字符。 默认取值： 不涉及。 表2 请求Body参数 参数 是否必选 参数类型 描述 repository_uuid 是 String 参数解释： 仓库UUID(由CreateRepository接口返回)。 取值范围： 由数字和字母组成，且长度为32个字符。 private_key 是 String 参数解释： 密钥，由用户上传。 取值范围： 只能数字组成，且长度为[0-2048]个字符。

请求示例 POST https://{endpoint}/v1/users/sshkey/privatekey/verify{ "private_key" : "-----BEGIN RSA PRIVATE KEY-----****-----END RSA PRIVATE KEY-----", "repository_uuid" : "9b2fab276e9240e09cd01ed0400fc439"}

响应参数 表3 响应Body参数 参数 参数类型 描述 error Error object 参数解释： 接口调用时，响应错误。 取值范围： 无。 result String 参数解释： 接口调用的响应结果。 取值范围： 无。 status String 参数解释： 调用此接口的响应状态。 取值范围： success，表示接口调用成功。 failed，表示接口调用失败。 表4 Error 参数 参数类型 描述 code String 参数解释： 调用此接口失败时返回的错误码。 message String 参数解释： 调用此接口失败时返回的提示信息。

响应示例 状态码： 200 OK { "id": 94895, "name": "ming", "username": "m012345", "name_cn": "明", "email": ", "state": "reject", "updated_at": "2024-08-16T15:25:57.208+08:00", "avatar_url": ""}

状态码 表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协议的版本，无法完成处理。 父主题： 附录

请求方法 HTTP请求方法（也称为操作或动词），它告诉代码托管你正在请求什么类型的操作，当前代码托管支持以下四种请求方法。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 在获取SSH密钥列表的URI部分，您可以看到其请求方法为“GET”，请求为： GET https://codehub-ext.cn-north-1.huaweicloud.com/v1/users/sshkey

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint：指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点中获取。 resource-path：资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要获取在“华北-北京一”区域的ssh key列表，则需使用“华北-北京一”区域的EndPoint（codehub-ext.cn-north-1.mytestcloud.com），并在获取SSH密钥列表的URI部分找到resource-path（v1/users/sshkey），拼接起来如下所示。 https://codehub-ext.cn-north-1.huaweicloud.com/v1/users/sshkey 为查看方便，在每个具体API的URI部分，只给出resource-path，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 公有云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参考AK/SK认证。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-1.mytestcloud.com/v3/auth/tokens Content-Type: application/json

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxx为project的名称，如cn-north-1，您可以从地区和终端节点中获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token额作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 POST https://iam.cn-north-1.mytestcloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取用户Token到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

响应示例 状态码： 200 OK { "result" : { "repoName" : "repoName", "commitCount" : "111", "repoSize" : "0.26 MB", "lastCommitTime" : "2020-01-01 11:11:11", "codeLines" : "368965", "branchCount" : "222", "archiveUrl" : "https://test.com/repo/v1/repo/repository/2111663431/archive" }, "status" : "success"}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 error Error object 参数解释： 响应错误码。 result RepositoryStatisticsVO object 参数解释： 响应结果。 status String 参数解释： 调用此接口的响应状态。 取值范围： success，表示接口调用成功。 failed，表示接口调用失败。 表4 Error 参数 参数类型 描述 code String 参数解释： 错误码。 取值范围： 符合错误码格式字符串，长度[0,100]。 message String 参数解释： 错误信息。 取值范围： 不涉及。 表5 RepositoryStatisticsVO 参数 参数类型 描述 repoName String 参数解释： 仓库名称。 commitCount Integer 参数解释： 提交次数。 repoSize String 参数解释： 仓库容量。 lastCommitTime String 参数解释： 最近一次提交时间。 codeLines Integer 参数解释： 代码行数。 branchCount Integer 参数解释： 分支数量。 archiveUrl String 参数解释： 代码仓下载地址。

响应示例 状态码： 200 OK { "id": "61366", "remark": "test12123", "ip_range": "1.0.0.1", "ip_type": 0, "ip_start": "1.0.0.1", "ip_end": "1.0.0.1", "view_flag": 0, "download_flag": 0, "upload_flag": 0, "created_at": "Nov 7, 2024 9:52:01 PM", "updated_at": "Nov 7, 2024 9:52:01 PM", "order_flag": 1, "repository_id": 2111965777}

请求Body 表3 请求Body参数 参数 参数类型 描述 ip_type String 格式类型，指定IP，IP范围，CIDR ip_start String 起始IP ip_end String 结束IP view_flag String 是否允许访问代码仓库 download_flag String 是否允许下载代码 upload_flag String 是否允许提交代码 remark String 备注

响应参数 状态码： 200 表4 响应Body参数(array) 参数 参数类型 描述 id String 关联结果 repository_id Integer 仓库ID ip_range String IP范围 ip_type Integer 格式类型，指定ip，ip范围，CIDR ip_start String 起始IP ip_end String 结束IP view_flag Integer 是否允许访问代码仓库 download_flag Integer 是否允许下载代码 upload_flag Integer 是否允许提交代码 remark String 备注 created_at String 创建时间 updated_at String 更新时间 order_flag Integer 排序 表5 Error 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 error Error object 响应错误 result Boolean 参数解释： 仓库是否存在。 取值范围： true，仓库不存在，名称可用。 false，仓库存在，名称不可用。 status String 响应状态 表4 Error 参数 参数类型 描述 code String 错误码 message String 错误信息

响应示例 状态码： 200 OK { "result": { "categories_and_modules_enabled": true, "secondary_category_enabled": false, "primary_categories": [ { "key": "realize", "name_zh": "算法实现", "name_en": "Algorithm" } ], "review_default_categories": [ "realize" ], "review_customized_categories": [ "分类" ], "review_modules": [ "模块" ], "source_id": 2111704470, "source_type": "Project", "source_path": "sll_test00006/mr_test" }, "status": "success"}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 error Error object 参数解释： 响应错误码 result ReviewSettingDto object 参数解释： 返回新建检视意见的相关信息。 取值范围： 无。 status String 参数解释： 响应状态。 取值范围： success，表示接口调用成功。 failed，表示接口调用失败。 表4 Error 参数 参数类型 描述 code String 参数解释： 调用此接口失败时返回的错误码。 取值范围： CH.10000，系统繁忙，请稍后再试。 message String 参数解释： 调用此接口失败时返回的提示信息。 取值范围： “系统繁忙，请稍后再试”。 表5 ReviewSettingDto 参数 参数类型 描述 categories_and_modules_enabled Boolean 参数解释： 是否启用检视意见分类与模块。 取值范围： true：启用检视意见分类与模块。 false：禁用检视意见分类与模块。 secondary_category_enabled Boolean 参数解释： 是否启用系统预置检视意见分类。 取值范围： true：启用系统预置检视意见分类。 false：禁用系统预置检视意见分类，此时可勾选分类或添加自定义分类。 primary_categories Array of CategoryDto objects 参数解释： 已勾选的分类。 取值范围： 无。 review_default_categories Array of strings 参数解释： 已勾选的分类的key。 取值范围： 无。 review_customized_categories Array of strings 参数解释： 自定义分类。 取值范围： 数量限制：20条。 单条长度限制：200字符。 单条字符限制：unicode编码\u0000 - \uffff，不支持emoji表情、部分生僻字等特殊字符。 单条blank限制：不能为null或空字符串或全是空格。 review_modules Array of strings 参数解释： 检视意见模块。 取值范围： 数量限制：20条。 单条长度限制：200字符。 单条字符限制：unicode编码\u0000 - \uffff，不支持emoji表情、部分生僻字等特殊字符。 单条blank限制：不能为null或空字符串或全是空格。 source_id Integer 参数解释： 仓库id。 取值范围： 最小值：1 最大值：2147483647 source_type String 参数解释： 项目类型，目前仅支持一种。 取值范围： Project source_path String 参数解释： 仓库路径。 取值范围： 无。 secondary_category_type String 参数解释： 系统预置检视意见分类(废弃字段)。 取值范围： HiCode secondary_categories Array of CategoryDto objects 参数解释： 系统预置检视意见。 取值范围： 无。 表6 CategoryDto 参数 参数类型 描述 key String 参数解释： 系统预置检视意见分类的key。 取值范围： 无。 name_zh String 参数解释： 系统预置检视意见分类的中文名。 取值范围： 无。 name_en String 参数解释： 系统预置检视意见分类的英文名。 取值范围： 无。 sub_categories Array of CategoryDto objects 参数解释： 系统预置检视意见分类的子分类。 取值范围： 无。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 error Object Error 响应错误 result MergeChangesTreesDto object 参数解释： 响应结果。 status String 参数解释： 调用此接口的响应状态。 取值范围： success，表示接口调用成功。 failed，表示接口调用失败 表4 响应Error参数 参数 参数类型 描述 code String 参数解释： 调用此接口失败时返回的错误码。 取值范围： CH.10000，系统繁忙，请稍后再试。 message String 参数解释： 调用此接口失败时返回的提示信息。 取值范围： “系统繁忙，请稍后再试”。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 关联结果 user_id Integer 用户ID domain_id String 租户ID ip_range String Ip范围 ip_type Integer 响应错误 ip_start String 起始IP ip_end String 结束IP view_flag Integer 是否允许访问代码仓库 download_flag Integer 是否允许下载代码 upload_flag Integer 是否允许提交代码 remark String 备注 created_at String 创建时间 updated_at String 更新时间 order_flag Integer 排序 表4 Error 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

响应示例 状态码： 200 OK { "id": "58119", "remark": "", "ip_range": "2.2.2.5", "ip_type": 0, "ip_start": "2.2.2.5", "ip_end": "2.2.2.5", "view_flag": 1, "download_flag": 1, "upload_flag": 1, "created_at": "Nov 6, 2024 4:58:05 PM", "updated_at": "Nov 6, 2024 4:58:05 PM", "order_flag": 1, "user_id": 7574, "domain_id": "********************************" }

请求Body 表2 请求Body参数 参数 参数类型 描述 ip_type String 格式类型，指定IP，IP范围，CIDR ip_start String 起始IP ip_end String 结束IP view_flag String 是否允许访问代码仓库 download_flag String 是否允许下载代码 upload_flag String 是否允许提交代码 remark String 备注