华为云用户手册

响应参数 客户服务器接收到 隐私保护通话 平台的短信事件通知后，根据不同的模式返回不同响应消息。 Notify模式 返回无消息体的200响应。 Block模式 响应必须参照表7携带消息体，返回对短信事件的处理操作。 表7 响应消息参数说明 参数名称 是否必选 参数类型 说明 actions 是 SMS ActionType[] 短信操作指示。 表8 SMSActionType定义 参数名称 是否必选 参数类型 说明 operation 是 String(1-32) 操作类型： vNumberRoute：转发短信。 DiscardMessage：丢弃短信。 message 否 MessageInfo 短信操作信息。 仅当operation取值为“vNumberRoute”时有效。 extParas 否 JsonArray 预留参数，当前版本无需关注。 userData 否 String(1-256) 用户自定义数据。 不允许携带以下字符：“{”，“}”（即大括号）。 不允许包含中文字符，如果包含中文字符请采用Base64编码。 说明： 使用该参数的场景请联系华为云客服获取。 表9 MessageInfo定义 参数名称 是否必选 参数类型 说明 called 否 String(1-64) 真实接收方号码。 号码仅支持全局号码格式（包含国家码），比如+86138****7022。 calling 否 String(1-64) 真实发送方号码。 和请求参数中的calling参数的取值保持一致。 号码仅支持全局号码格式（包含国家码），比如+86138****7021。

接口示例 接口示例仅供参考，请以实际消息为准。 notify模式 请求示例 POST /notify HTTP/1.1 content-type: application/json;charset=UTF-8 authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey" x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z" content-length:xx { "appKey":"****", "smsEvent":{"smsIdentifier":"********", "notificationMode":"Notify", "calling":"+86138****0001", "virtualNumber":"+86138****0000", "event":"TextSMS", "timeStamp":"2020-12-23T09:06:16.450Z", "extInfo":{"extParas":[{"key":"splitNum","value":"0"},{"key":"direction","value":"2"}]}, "sendResult":2 } } 响应示例 HTTP/1.1 200 OK Block模式 请求示例 POST /block HTTP/1.1 content-type: application/json;charset=UTF-8 authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey" x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z" content-length:xx { "appKey":"****", "smsEvent":{"smsIdentifier":"****", "notificationMode":"Block", "calling":"+86138****0001", "virtualNumber":"+86138****0000", "event":"TextSMS", "timeStamp":"2018-09-13T09:46:16.023Z", "extInfo":{"extParas":[{"key":"splitNum","value":"2"},{"key": "direction","value": "1"}]}, "sendResult":0 } } 响应示例 HTTP/1.1 200 OK Content-Type: application/JSON;charset=UTF-8 Content-Length: xx { "actions":[{ "operation":"vNumberRoute", "message":{"called":"+86138****0002", "calling":"+86138****0001" } }] }

请求参数 表2 请求Headers参数说明 参数名称 是否必选 参数类型 说明 Content-Type 是 String 固定填写为application/json;charset=UTF-8。 Authorization 是 String 固定填写为AKSK realm="SDP",profile="UsernameToken",type="Appkey"。 X-AKSK 是 String 取值为UsernameToken Username="APP_Key的值", PasswordDigest="PasswordDigest的值", Nonce="随机数", Created="随机数生成时间"。 PasswordDigest：根据PasswordDigest = Base64 (HMAC-SHA256 (Password，Nonce + Created))生成。其中，Password为APP_Secret的值。Nonce、Created、Password直接进行字符串拼接即可，无需包含+号和空格。 Nonce：客户发送请求时生成的一个随机数，长度为1~128位，可包含数字和大小写字母。例如：66C92B11FF8A425FB8D4CCFE0ED9ED1F。 Created：随机数生成时间。采用标准UTC格式，例如：2018-02-12T15:30:20Z。不同编程语言中将UTC时间戳转换为普通时间时使用的格式不同，部分语言可参考表3。 表3 不同编程语言的时间格式 编程语言 时间格式 Java yyyy-MM-dd'T'HH:mm:ss'Z' PHP Y-m-d\TH:i:s\Z Python %Y-%m-%dT%H:%M:%SZ C# yyyy-MM-ddTHH:mm:ssZ Node.js toISOString().replace(/.[0-9]+\Z/, 'Z') 注：Node.js中，使用toISOString()转换后的时间格式去除毫秒后即为本接口要求的时间格式。 表4 请求Body参数说明 参数名称 是否必选 参数类型 说明 appKey 是 String(1-32) 隐私保护通话应用的APP_Key。 smsEvent 是 SMSEventInfoType 短信状态事件。 表5 SMSEventInfoType定义 参数名称 是否必选 参数类型 说明 smsIdentifier 是 String(1-64) 短信唯一标识。 若用户发送的是长短信，隐私保护通话平台会将长短信的多个分片合并为一个通知上报。 notificationMode 是 String(1-8) 通知模式： Notify：通知模式。 Block：控制模式。 calling 否 String(1-32) 真实发送方号码。 号码为全局号码格式（包含国家码），比如+86138****7021。 called 否 String(1-32) 真实接收方号码。 仅在隐私保护通话平台转发短信成功后携带。 号码为全局号码格式（包含国家码），比如+86138****7022。 virtualNumber 否 String(1-32) X号码。 号码为全局号码格式（包含国家码），比如+86138****0001。 event 是 String(1-16) 短信状态事件。 TextSMS：文本短信 timeStamp 是 String(1-32) 短信事件发生的系统时间戳，UTC时间。 格式：yyyy-MM-dd'T'HH:mm:ss.SSS'Z' 其中SSS是毫秒，“T”和“Z”为固定字符。 extInfo 是 ExtensionInfoType 拓展信息。 subscriptionId 否 String(1-64) 绑定ID。 smsContent 否 String(1-2000) 用户发送的短信内容。 请参考如何设置才能收到短信内容？开通该功能。 sendResult 是 Integer 发送结果。 0：成功 1：因用户账户冻结，发送失败。 2：因绑定关系不存在，发送失败。 3：因X号码被暂停，发送失败。 4：非商用APP，发送失败。 5：因系统内部错误，发送失败。 6：SP指示丢弃，发送失败。 7：等待SP审核超时丢弃，发送失败。 8：黑名单管控，发送失败。 9：部分发送成功。 10：全部发送失败。 11：X号码不支持短信能力。 12：短信内容不包含特征关键词。 13：短信内容包含禁止词汇。 16： 从业者未实名 areaCode 否 String(0-32) 隐私保护号码（X号码）的城市码。 说明： 使用该参数的场景请联系华为云客服获取。 userData 否 String(1-256) 用户附属信息。 说明： 使用该参数的场景请联系华为云客服获取。 表6 ExtensionInfoType定义 参数名称 是否必选 参数类型 说明 extParas 是 JsonArray 扩展信息(Key-Value)列表。 格式如下： "extParas": [{"key": "splitNum","value": "value1"},{"key": "direction","value": "value2"}] Key、Value取值分别不能超过32个字节。 “key”取值为“splitNum”时表示实际短信发送成功数量，即长短信拆分后的短信数量。value1表示“splitNum”的取值。 “key”取值为“direction”时表示短信发送方向。value2表示“direction”取值，含义如下： 0：其他用户发送短信给A。 1：A发送短信给其他用户。 2：异常场景无法获取发送方向。

接口功能 隐私保护通话平台通过此接口向客户服务器推送隐私号短信通知。 通知模式分为Notify和Block模式： Notify：通知模式，Notify模式的短信通知会被推送到客户添加应用时填写的短信通知地址，客户收到通知后返回HTTP状态码为200的空消息即可。 Block：控制模式，Block模式的短信通知会被推送到客户添加应用时填写的短信控制地址，客户收到通知后需按照Block模式响应参数返回响应，指示隐私保护通话平台转发或丢弃短信。 AX模式发送隐私号短信的流程如下： A发送短信给X，短信内容最后携带“@号码B”，如“@138****0021”（@必须是英文半角字符，号码B根据实际情况替换成真实用户号码，下同），隐私保护通话平台删除短信内容中的“@号码B”后将短信转发给B（发送方号码是X），并推送Notify模式的隐私号短信通知给客户服务器； 若短信内容中未携带“@号码B”或携带的分隔符或号码格式错误，则隐私保护通话平台推送Block模式的隐私号短信通知给客户服务器，此时客户服务器必须返回响应参数对短信事件进行控制。隐私保护通话平台根据客户服务器返回的结果转发或丢弃隐私号短信；如果操作是转发，转发成功后推送Notify模式的隐私号短信通知给客户服务器。 B发送短信给X，隐私保护通话平台在短信最后添加“[From号码B]”后将短信转发给A（发送方号码是X），并推送Notify模式的隐私号短信通知给客户服务器。 注：AX模式，A发送短信给X时需携带“@号码B”，“@号码B”不能去除。

接口示例 接口示例仅供参考，请以实际消息为准。 请求示例 POST /notify HTTP/1.1 content-type: application/json;charset=UTF-8 authorization: AKSK realm="SDP",profile="UsernameToken",type="Appkey" x-aksk: UsernameToken Username="************",PasswordDigest="*************",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z" content-length:xx { "appKey":"****", "smsEvent":{"smsIdentifier":"********", "notificationMode":"Notify", "calling":"+86138****0001", "virtualNumber":"+86138****0000", "event":"TextSMS", "timeStamp":"2020-12-23T09:06:16.450Z", "extInfo":{"extParas":[{"key":"splitNum","value":"0"},{"key":"direction","value":"2"}]}, "sendResult":2 } } 响应示例 请求为Notify模式时 HTTP/1.1 200 OK

请求参数 表2 请求Headers参数说明 参数名称 是否必选 参数类型 说明 Content-Type 是 String 固定填写为application/json;charset=UTF-8。 Authorization 是 String 固定填写为AKSK realm="SDP",profile="UsernameToken",type="Appkey"。 X-AKSK 是 String 取值为UsernameToken Username="APP_Key的值", PasswordDigest="PasswordDigest的值", Nonce="随机数", Created="随机数生成时间"。 PasswordDigest：根据PasswordDigest = Base64 (HMAC-SHA256 (Password，Nonce + Created))生成。其中，Password为APP_Secret的值。Nonce、Created、Password直接进行字符串拼接即可，无需包含+号和空格。 Nonce：客户发送请求时生成的一个随机数，长度为1~128位，可包含数字和大小写字母。例如：66C92B11FF8A425FB8D4CCFE0ED9ED1F。 Created：随机数生成时间。采用标准UTC格式，例如：2018-02-12T15:30:20Z。不同编程语言中将UTC时间戳转换为普通时间时使用的格式不同，部分语言可参考表3。 表3 不同编程语言的时间格式 编程语言 时间格式 Java yyyy-MM-dd'T'HH:mm:ss'Z' PHP Y-m-d\TH:i:s\Z Python %Y-%m-%dT%H:%M:%SZ C# yyyy-MM-ddTHH:mm:ssZ Node.js toISOString().replace(/.[0-9]+\Z/, 'Z') 注：Node.js中，使用toISOString()转换后的时间格式去除毫秒后即为本接口要求的时间格式。 表4 请求Body参数说明 参数名称 是否必选 参数类型 说明 appKey 是 String(1-32) 隐私保护通话应用的APP_Key。 smsEvent 是 SMSEventInfoType 短信状态事件。 表5 SMSEventInfoType定义 参数名称 是否必选 参数类型 说明 smsIdentifier 是 String(1-64) 短信唯一标识。 若用户发送的是长短信，隐私保护通话平台会将长短信的多个分片合并为一个通知上报。 notificationMode 是 String(1-8) 通知模式： Notify：通知模式。 calling 否 String(1-32) 真实发送方号码。 号码为全局号码格式（包含国家码），比如+86138****7021。 called 否 String(1-32) 真实接收方号码。 仅在隐私保护通话平台转发短信成功后携带。 号码为全局号码格式（包含国家码），比如+86138****7022。 virtualNumber 否 String(1-32) X号码。 号码为全局号码格式（包含国家码），比如+86138****0001。 event 是 String(1-16) 短信状态事件。 TextSMS：文本短信 timeStamp 是 String(1-32) 短信事件发生的系统时间戳，UTC时间。 格式：yyyy-MM-dd'T'HH:mm:ss.SSS'Z' 其中SSS是毫秒，“T”和“Z”为固定字符。 extInfo 是 ExtensionInfoType 拓展信息。 subscriptionId 否 String(1-64) 绑定ID。 smsContent 否 String(1-2000) 用户发送的短信内容。 请参考如何设置才能收到短信内容？开通该功能。 sendResult 是 Integer 发送结果。 0：成功 1：因用户账户冻结，发送失败。 2：因绑定关系不存在，发送失败。 3：因X号码被暂停，发送失败。 4：非商用APP，发送失败。 5：因系统内部错误，发送失败。 8：黑名单管控，发送失败。 9：部分发送成功。 10：全部发送失败。 11：X号码不支持短信能力。 12：短信内容不包含特征关键词。 13：短信内容包含禁止词汇。 16： 从业者未实名 areaCode 否 String(0-32) 隐私保护号码（X号码）的城市码。 说明： 使用该参数的场景请联系华为云客服获取。 userData 否 String(1-256) 用户附属信息。 说明： 使用该参数的场景请联系华为云客服获取。 表6 ExtensionInfoType定义 参数名称 是否必选 参数类型 说明 extParas 是 JsonArray 扩展信息(Key-Value)列表。 格式如下： "extParas": [{"key": "splitNum","value": "value1"},{"key": "direction","value": "value2"}] Key、Value取值分别不能超过32个字节。 “key”取值为“splitNum”时表示实际短信发送成功数量，即长短信拆分后的短信数量。value1表示“splitNum”的取值。 “key”取值为“direction”时表示短信发送方向。value2表示“direction”取值，含义如下： 0：B发送短信给A。 1：A发送短信给B。 2：异常场景无法获取发送方向。

呼叫拆线点说明 拆线点 拆线点描述 0 接通后主动挂机 522 语音端口不足 7001 开发者呼叫频次管控 7002 应用呼叫频次管控 7003 主显号码呼叫频次管控 7004 被叫黑名单呼叫管控 7005 主叫黑名单管控 7100 应用信息不存在 7101 应用未申请隐私号码资源 7102 服务内部出错 7103 主叫号码信息不存在 7104 AX绑定关系不存在 7105 业务类型不匹配 7106 应用无隐私保护通话能力 7107 安全管控提示音放音失败 7108 用户状态已冻结 7109 语音端口不足 7500 呼叫前缀被限制 7501 被叫振铃前主叫挂机 7502 被叫振铃后主叫挂机 7503 被叫挂机 7504 呼叫被拒绝 7505 主叫侧网络异常 7506 被叫侧网络异常（例如绑定的号码格式错误） 7507 无放音文件 7508 路由失败 7516 呼叫转接前主叫挂机。 例如AXE模式未输入分机号，主叫主动挂机，非OMP下发terminate场景。 8002 接续用户时对端返回失败放音 8003 用户振铃超时 8004 用户振铃时挂机 8005 TTS 转换失败 8006 放音文件不存在 8007 给用户放音失败 8008 给用户放音收号失败 8009 接通前主叫用户主动挂机 8010 超过通话最大时长挂机 8011/8040 内部错误 8012 无效的app_key 8013 无效的AX模式呼叫（存在AX绑定，但无临时被叫） 8014 无效的AXB模式呼叫 8015/8041 给用户录音失败 8016 AX/AXB模式呼叫方向不允许 8017 X模式客户指示挂机 8018 业务无权限（包含：不存在AX绑定关系） 8019 回呼记录不存在（AXE/AX模式，A呼X场景） 8020 业务异常 8022 绑定关系不存在或已过期（AXE模式，B呼X场景） 8023 不允许固话号码作为主叫号码 8024 不允许使用显示真实主叫号码模式 8025 呼叫的X号码不存在（AXE模式） 8030 AXYB模式绑定关系不存在 8031 呼叫过程中分配Y号码失败 8032 AXYB模式呼叫过程中原号码拨打自己绑定的隐私号导致呼叫失败 8033 收到的分机号为空 8035 被叫无应答，振铃超时未响应 8042 国际呼入限制 8043 国际呼出限制 8044 通话时间异常管控 8046 接通率异常管控 8047 主叫呼叫频次管控 8048 被叫呼叫频次管控 8049 业务号码呼叫频次管控 8050 呼叫时段限制 8051 子企业暂停 8055 X号码无呼叫和短信权限，请检查X号码状态 8056 拨测号码管控 8057 呼叫方向管控 8058 从业者未实名 8100 被叫号码不存在 8101 被叫无应答 8102 被叫用户正忙（被叫正在通话、振铃等） 8103 被叫用户暂时无法接通 8104 被叫已关机（被叫处于关机、飞行模式、无网络等状态） 8105 被叫挂机或被叫已停机 8139 其他异常行为 父主题： 附录

通话挂机原因值说明 分类 错误码 描述 - 0 接通后主动挂机 绑定关系 8013 无效AX模式呼叫（存在AX绑定，但无临时被叫） 8014 无效AXB/X模式呼叫（绑定关系不存在，号码格式错误等） 8016 AX/AXB模式呼叫方向不允许 8019 回呼记录不存在 AXE模式，A呼叫X场景 AX模式，A回呼X场景 8022 绑定关系不存在或已过期（AXE模式，B呼X场景） 8030 AXYB模式绑定关系不存在 8031 AXYB模式呼叫过程中分配Y号码失败 主叫 7501 被叫振铃前主叫挂机 7502 被叫振铃后主叫挂机 7516 呼叫转接前主叫挂机。例如AXE模式主叫输入分机号前主动挂机 8033 收到分机号为空 8032 AXYB模式呼叫过程中原号码拨打自己绑定的隐私号导致呼叫失败 号码 8025 呼叫的X号码不存在（AXE模式） 被叫 7503 被叫拒接 7504 呼叫被拒绝，可能的原因如下： 被叫拒接 被叫开通免打扰、黑名单一类的呼叫限制业务 被叫系统拦截，可能原因是安装了拦截软件，或者设置了黑名单 8035 隐私保护呼叫平台接续超时，超时时间为呼叫转接后90秒左右 8100 被叫号码不存在 8101 被叫振铃后无应答，运营商网络原因，超时时间由运营商决定 8102 被叫用户正忙（被叫正在通话、振铃等） 8103 被叫信号异常，导致运营商未接续到被叫 8104 被叫已关机（被叫处于关机、飞行模式、无网络等状态） 8105 被叫已停机 租户 7100 应用信息不存在 7101 应用未申请隐私号码资源 7105 业务类型不匹配 7106 应用无隐私保护通话能力 7108 用户状态已冻结 7507 无放音文件 8006 X模式放音文件不存在 8010 超过通话最大时长挂机 管控 7001 开发者呼叫频次管控 7002 应用呼叫频次管控 7003 主显号码呼叫频次管控 7004 被叫黑名单呼叫管控 7005 主叫黑名单管控 7107 安全管控提示音放音失败 7109 租户语音端口不足 7500 呼叫前缀被限制 8018 业务无权限（包含：不存在AX绑定关系） 8023 不允许固话号码作为主叫号码 8024 不允许使用显示真实主叫号码模式 8042 国际呼入限制 8043 国际呼出限制 8044 通话时间异常管控 8046 接通率异常管控 8047 主叫呼叫频次管控 8048 被叫呼叫频次管控 8049 业务号码呼叫频次管控 8050 呼叫时段限制 8051 子企业被暂停 8055 X号码不可用，呼叫和短信功能不可用 8056 拨测号码管控 8057 呼叫方向管控 8058 从业者未实名 平台 522 平台语音端口不足 8007 最后一分钟放音失败 8008 给用户放音收号失败 8015/8041 给用户录音失败 7102/8011/8020/8040/8139 其他异常行为 网络 7505 主叫侧网络异常 7506 被叫侧网络异常（例如绑定的号码格式错误） 7508 路由失败 父主题： 附录

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 status String 参数解释: 请求成功、失败状态。 取值范围: success: 请求成功。 error：请求失败。 trace_id String 参数解释: 请求id，当前请求唯一标识。 取值范围: 数字及中划线(-)组成的字符串。 result Object 参数解释: 请求返回结果，接口不同，返回不同。 取值范围: 根据不同接口有不同范围。

响应示例 状态码：200 OK { "status" : "success", "trace_id" : "76629-1718852080645-39", "result" : { "is_schedule_to_trash" : true, "is_schedule_to_delete" : true, "file_expire_time" : 90, "trash_file_expire_time" : 66, "project_id" : "6666669620d743eca6a57881a0f006fd", "cleanRule" : { "skipAutoTrash" : { "packageCategory" : "prod", "paths" : [ "/a/b/c", "/d/d" ] } } } }

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 status String 参数解释: 请求成功、失败状态。 取值范围: success: 请求成功。 error：请求失败。 trace_id String 参数解释: 请求id，当前请求唯一标识。 取值范围: 数字及中划线(-)组成的字符串。 result Object 参数解释: 请求返回结果，接口不同，返回不同。 取值范围: 根据不同接口有不同范围。

响应示例 状态码：200 OK { "status" : "success", "trace_id" : "142838-1718767424403-26988", "result" : { "needNotice" : true, "crossTenant" : false, "packageType" : 13, "packageStatus" : 1, "totalStorage" : "500GB", "totalDownloadTraffic" : "100GB", "usedStorage" : "46.69GB", "monthUsedTraffic" : "361.0B", "storagePercent" : 0.09, "trafficPercent" : 0, "packageDetail" : 0, "maxRepoNum" : "Infinity" } }

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 status String 参数解释: 请求成功、失败状态。 取值范围: success：请求成功。 error：请求失败。 trace_id String 参数解释: 请求id，当前请求唯一标识。 取值范围: 数字及中划线(-)组成的字符串。 result CreateMavenRepoResult object 参数解释: 创建的maven仓库信息。 取值范围: 不涉及。 表3 CreateMavenRepoResult 参数 参数类型 描述 release String 参数解释: release仓库id。 取值范围: 不涉及。 snapshot String 参数解释: snapshot仓库id。 取值范围: 不涉及。

请求示例 创建maven仓库 https://artifact.cn-south-1.myhuaweicloud.com/cloudartifact/v5/maven/repositories { "repository_name" : "testmaven", "format" : "maven2", "description" : "", "release" : "testmaven", "snapshot" : "testmaven", "includes_pattern" : "**/*", "share_right" : "PROJECT", "project_id" : "e2ee90487d6349dd944a5767225f6f55", "type" : "hosted" }

响应示例 状态码：200 OK { "status" : "success", "trace_id" : "143002-1701175135227-77", "result" : { "release" : "cn-north-7_5a775fdcb14f4431b6c0015618140bc3_maven_1_201", "snapshot" : "cn-north-7_5a775fdcb14f4431b6c0015618140bc3_maven_2_201" } }

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 repository_name 是 String 参数解释: 仓库名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 无。 format 是 String 参数解释: 制品类型。 约束限制: 不涉及。 取值范围: maven2。 默认取值: 无。 description 否 String 参数解释: 仓库描述。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 无。 release 否 String 参数解释: release仓库名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 无。 snapshot 否 String 参数解释: snapshot仓库名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 无。 includes_pattern 否 String 参数解释: 路径包含规则。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 无。 share_right 否 String 参数解释: 共享权限级别。 约束限制: 不涉及。 取值范围: PROJECT。 默认取值: 无。 project_id 否 String 参数解释： 项目ID，对应"需求管理 CodeArts Req"项目唯一标识，私有依赖库首页地址栏url https://{host}/cloudartifact/project/{project_id}/repository中project_id变量的值。 约束限制： 不涉及。 取值范围： 字符串长度32。 默认取值： 不涉及。 type 是 String 参数解释: 仓库类型。 约束限制: 不涉及。 取值范围: hosted：本地仓库。 默认取值: 无。

响应示例 状态码：200 OK { "status" : "success", "trace_id" : "143002-1701244804975-630", "result" : { "status" : 0, "domainId" : "5a775fdcb14f4431b6c0015618140bc3", "region" : "cn-north-7", "createdTime" : "2021-05-19 19:50:30", "modifiedTime" : "2023-11-28 21:00:56", "id" : 3000110176, "userId" : "e9253deb37654775bb3c411aca89153a", "userName" : "devcloud_devcloud_y00226182_01", "userType" : "personal", "repoUserName" : "5a775fdcb14f4431b6c0015618140bc3_e9253deb37654775bb3c411aca89153a", "repoNumber" : 58, "innerRepoUserName" : "cn-north-7_5a775fdcb14f4431b6c0015618140bc3_e9253deb37654775bb3c411aca89153a" } }

响应参数 状态码：200 表1 响应Body参数 参数 参数类型 描述 status String 参数解释: 请求成功、失败状态。 取值范围: success: 请求成功。 error：请求失败。 trace_id String 参数解释: 请求id，当前请求唯一标识。 取值范围: 数字及中划线(-)组成的字符串。 result Object 参数解释: 请求返回结果，接口不同，返回不同。 取值范围: 根据不同接口有不同范围。

请求示例 通过checksum搜索文件 https://artifact.cn-south-1.myhuaweicloud.com/cloudartifact/v5/search/checksum?checksum=eb05a9df1e3403a5f54e03de073a6ce6&page_no=1&page_size=10&in_project=true&project_id=e2ee90487d6349dd944a5767225f6f55&format=pypi

URI GET /cloudartifact/v5/search/checksum 表1 Query参数 参数 是否必选 参数类型 描述 checksum 是 String 参数解释: 文件校验和，可在页面文件详细信息概览中获取，文件校验和的MD5, SHA-1, SHA-256, SHA-512任意值。 约束限制: 不涉及。 取值范围: 只能使用英文字符、数字，字符串长度32、40、64、128。 默认取值: 不涉及。 page_no 否 Integer 参数解释: 页码。 约束限制: 不涉及。 取值范围: 最小值1。 默认取值: 1 page_size 否 Integer 参数解释: 每页大小。 约束限制: 不涉及。 取值范围: 最小值1，最大值100。 默认取值: 10 format 否 String 参数解释: 仓库类型。 约束限制: 不涉及。 取值范围: 允许的类型为: maven2|npm|go|pypi|rpm|composer|debian|conan|nuget|docker2|cocoapods|ohpm。 默认取值: 不涉及。 in_project 否 String 参数解释: 是否在项目中，值为true，project_id有值时，查询指定项目数据；project_id无值时，查询当前账号所有项目数据。值为false或不传值时查询当前租户下未关联项目的仓库数据。 约束限制: 不涉及。 取值范围: true or false。 默认取值: 不涉及。 project_id 否 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，私有依赖库首页地址栏url https://{host}/cloudartifact/project/{project_id}/repository中project_id变量的值。 约束限制: 参数in_project值为true值时此参数生效。 取值范围: 只能使用小写英文字符及数字，字符串长度为32位。 默认取值: 不涉及。

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 status String 参数解释: 请求成功、失败状态。 取值范围: success：请求成功。 error：请求失败。 trace_id String 参数解释: 请求id，当前请求唯一标识。 取值范围: 数字及中划线(-)组成的字符串。 result Array of ArtifactSearchResult objects 参数解释: 文件列表。 取值范围: 不涉及。 表3 ArtifactSearchResult 参数 参数类型 描述 name String 参数解释: 文件名。 取值范围: 不涉及。 relativePath String 参数解释: 文件相对路径。 取值范围: 不涉及。 repo String 参数解释: 仓库id。 取值范围: 不涉及。 repoName String 参数解释: 仓库名。 取值范围: 不涉及。 displayName String 参数解释: 展示名称。 取值范围: 不涉及。 repoType String 参数解释: 制品类型。 取值范围: 不涉及。 createdBy String 参数解释: 创建人id。 取值范围: 不涉及。 createdUserName String 参数解释: 创建人名字。 取值范围: 不涉及。 created String 参数解释: 创建时间。 取值范围: 不涉及。 modified String 参数解释: 修改时间。 取值范围: 不涉及。 oldRepoId String 参数解释: 旧仓库id。 取值范围: 不涉及。

响应示例 状态码：200 OK { "status" : "success", "trace_id" : "143006-1701220804200-277", "result" : [ { "name" : "mod.txt", "relativePath" : "1/1/mod.txt", "createdBy" : null, "createdUserName" : "devcloud_devcloud_y00226182_01", "created" : null, "modified" : "2023-11-29T09:19:13.711+08:00", "repo" : "cn-north-7_5a775fdcb14f4431b6c0015618140bc3_pypi_40", "repoName" : "testpypi", "displayName" : null, "oldRepoId" : "cn-north-7_5a775fdcb14f4431b6c0015618140bc3_pypi_40", "repoType" : "pypi" } ] }

URI GET /cloudartifact/v5/storage 表1 Query参数 参数 是否必选 参数类型 描述 format_list 否 String 参数解释： 仓库类型列表。 约束限制： 不涉及。 取值范围： maven2，docker，conan，debian，go，nuget，rpm，pypi，npm，cocoapods，generic。 默认取值： 不涉及。 in_project 否 String 参数解释： 是否在项目中。 约束限制： 不涉及。 取值范围： true：项目中。 false：项目外。 默认取值： 不涉及。

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 status String 参数解释: 请求成功、失败状态。 取值范围: success: 请求成功。 error：请求失败。 trace_id String 参数解释: 请求id，当前请求唯一标识。 取值范围: 数字及中划线(-)组成的字符串。 result Object 参数解释: 请求返回结果，接口不同，返回不同。 取值范围: 根据不同接口有不同范围。

URI GET /cloudartifact/v5/attention/artifacts 表1 Query参数 参数 是否必选 参数类型 描述 page_no 否 Integer 参数解释: 页码。 约束限制: 不涉及。 取值范围: 最小值1。 默认取值: 1 page_size 否 Integer 参数解释: 每页大小。 约束限制: 不涉及。 取值范围: 最小值1，最大值100。 默认取值: 10 project_id 否 String 参数解释: 项目id，对应"需求管理 CodeArts Req"项目唯一标识，私有依赖库首页地址栏url https://{host}/cloudartifact/project/{project_id}/repository中project_id变量的值。 约束限制: 不涉及。 取值范围: 只能使用小写英文字符及数字，字符串长度为32位。 默认取值: 不涉及。

响应示例 状态码：200 OK { "status" : "success", "trace_id" : "143006-1701222864960-289", "result" : { "data" : [ { "id" : "43e78ea4903d468db517e069ab91ce1c", "domainId" : "5a775fdcb14f4431b6c0015618140bc3", "repositoryId" : "cn-north-7_5a775fdcb14f4431b6c0015618140bc3_maven_1_108", "repositoryName" : "maven1", "format" : "maven2", "policy" : "release", "artifactId" : "cn-north-7_5a775fdcb14f4431b6c0015618140bc3_maven_1_108/1/1/1/1-1-1.jar", "path" : "cn-north-7_5a775fdcb14f4431b6c0015618140bc3_maven_1_108/1/1/1/1-1-1.jar", "modifiedUserName" : "devcloud_devcloud_y00226182_01", "modifiedUserId" : "e9253deb37654775bb3c411aca89153a", "userId" : null, "modifiedTime" : "2023-11-29 09:54:22", "region" : "cn-north-7" } ], "totalRecords" : 1, "totalPages" : 1 } }

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 status String 参数解释: 请求成功、失败状态。 取值范围: success：请求成功。 error：请求失败。 trace_id String 参数解释: 请求id，当前请求唯一标识。 取值范围: 数字及中划线(-)组成的字符串。 result ListAttentionPageResult object 参数解释: 关注列表。 取值范围: 不涉及。 表3 ListAttentionPageResult 参数 参数类型 描述 totalRecords Integer 参数解释: 总记录数。 取值范围: 不涉及。 totalPages Integer 参数解释: 总页数。 取值范围: 不涉及。 data Array of ListAttentionResult objects 参数解释: 关注列表。 取值范围: 不涉及。 表4 ListAttentionResult 参数 参数类型 描述 id String 参数解释: 序号。 取值范围: 不涉及。 domainId String 参数解释: 租户id。 取值范围: 不涉及。 repositoryId String 参数解释: 仓库id。 取值范围: 不涉及。 repositoryName String 参数解释: 仓库名称。 取值范围: 不涉及。 format String 参数解释: 制品类型。 取值范围: maven2|docker|npm|go|pypi|rpm|composer|debian|conan|nuget|docker2|cocoapods|ohpm|generic。 policy String 参数解释: 仓库策略。 取值范围: release。 snapshot。 artifactId String 参数解释: 关注的组件序号。 取值范围: 不涉及。 path String 参数解释: 关注的组件路径。 取值范围: 不涉及。 modifiedUserName String 参数解释: 修改人名字。 取值范围: 不涉及。 modifiedUserId String 参数解释: 修改人id。 取值范围: 不涉及。 userId String 参数解释: 用户id。 取值范围: 不涉及。 modifiedTime String 参数解释: 修改时间，时间格式：yyyy-MM-dd HH:mm:ss。 取值范围: 不涉及。 region String 参数解释: 区域。 取值范围: 不涉及。

响应示例 状态码：200 OK { "status" : "success", "trace_id" : "143003-1701176455154-4616", "result" : { "artifactory" : { "status" : null, "domainId" : "5a775fdcb14f4431b6c0015618140bc3", "region" : "cn-north-7", "createdTime" : null, "modifiedTime" : null, "createdUserId" : "e9253deb37654775bb3c411aca89153a", "createdUserName" : "devcloud_devcloud_y00226182_01", "modifiedUserId" : "e9253deb37654775bb3c411aca89153a", "modifiedUserName" : "devcloud_devcloud_y00226182_01", "name" : "cn-north-7_5a775fdcb14f4431b6c0015618140bc3_pypi_41", "disable" : false, "format" : "pypi", "type" : "hosted", "policy" : null, "tabId" : null, "repositoryName" : "test-pypi", "displayName" : null, "description" : "", "snapshot" : null, "release" : null, "npm" : null, "snapshotStatus" : null, "releaseStatus" : null, "projectId" : "e2ee90487d6349dd944a5767225f6f55", "includesPattern" : "**/*", "repositoryIds" : null, "uri" : null, "deploymentPolicy" : null, "repositories" : null, "parentRepoName" : null, "userName" : null, "password" : null, "remoteUrl" : null, "defaultDeployRepository" : null, "remoteType" : null, "proxy" : null, "allowAnonymous" : null, "autoCleanSnapshot" : null, "snapshotAliveDays" : null, "maxUniqueSnapshots" : null, "shareRight" : "PROJECT", "nexuRepo" : false, "url" : "https://devrepo.devcloud.cn-north-7.ulanqab.huawei.com/artgalaxy/api/pypi/cn-north-7_5a775fdcb14f4431b6c0015618140bc3_pypi_41/", "packageType" : "pypi" } } }

响应参数 状态码：200 表2 响应Body参数 参数 参数类型 描述 status String 参数解释: 请求成功、失败状态。 取值范围: success: 请求成功。 error：请求失败。 trace_id String 参数解释: 请求id，当前请求唯一标识。 取值范围: 数字及中划线(-)组成的字符串。 result Object 参数解释: 请求返回结果，接口不同，返回不同。 取值范围: 根据不同接口有不同范围。

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 format 是 String 仓库格式 type 是 String 仓库类型 repository_name 是 String 仓库名称 description 否 String 仓库描述 includes_pattern 是 String 路径白名单 project_id 否 String 项目id share_right 否 String 共享策略