# 验证供应商配置 - VerifyProvider #### 功能介绍 验证供应商连通性和 API Key 有效性。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=VerifyProvider)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | workspace:modelProvider:verify | Write | - | - | - | - | #### URI POST /v3/ai-agents/model-providers/verify #### 请求参数 表1请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | id | 否 | String | 供应商主键ID。传入时，其他空字段从数据库已保存的供应商记录中补充。 | | provider_type | 否 | String | 供应商类型。 | | provider_id | 否 | String | 供应商id（从模板实例化后的ID）。 | | api_key | 否 | String | 供应商API Key（SCC加密存储）。 | | api_type | 否 | String | API协议类型（OpenAI/Anthropic）。 | | base_url | 否 | String | 供应商base_url。 | | custom_config | 否 | [ProviderCustomConfig] object | 自定义配置内容。 | | model_id | 否 | String | 用于验证连接的模型ID。调用Chat Completion接口时作为model参数传入。 | 表2ProviderCustomConfig | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | model_list_api | 否 | String | 模型列表接口地址，用于查询供应商远程模型。 | | auth_header | 否 | String | 认证请求头名称。 | | auth_prefix | 否 | String | 认证前缀（如Bearer）。 | | model_id_field | 否 | String | 供应商模型列表中模型ID字段名。 | | model_name_field | 否 | String | 供应商模型列表中模型名称字段名。 | | headers | 否 | Map\ | 自定义HTTP请求头，调用供应商API时附加。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | provider_id | String | 供应商id。 | | success | Boolean | 是否验证成功。 | | message | String | 验证结果信息。 | **状态码：400** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述，遵循三段式格式：{描述}.{原因}.{方案}。 - 描述：简要说明发生了什么错误。 - 原因：说明导致错误的根本原因。 - 方案：给出修复建议或后续操作指引。 | **状态码：401** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述，遵循三段式格式：{描述}.{原因}.{方案}。 - 描述：简要说明发生了什么错误。 - 原因：说明导致错误的根本原因。 - 方案：给出修复建议或后续操作指引。 | **状态码：403** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述，遵循三段式格式：{描述}.{原因}.{方案}。 - 描述：简要说明发生了什么错误。 - 原因：说明导致错误的根本原因。 - 方案：给出修复建议或后续操作指引。 | **状态码：422** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述，遵循三段式格式：{描述}.{原因}.{方案}。 - 描述：简要说明发生了什么错误。 - 原因：说明导致错误的根本原因。 - 方案：给出修复建议或后续操作指引。 | **状态码：500** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述，遵循三段式格式：{描述}.{原因}.{方案}。 - 描述：简要说明发生了什么错误。 - 原因：说明导致错误的根本原因。 - 方案：给出修复建议或后续操作指引。 | #### 请求示例 ``` POST /v3/ai-agents/model-providers/verify { "id" : "185482637293647", "provider_type" : "hw_maas", "provider_id" : "provider-uuid-001", "api_key" : "sk-xxxxxxxxxxxxxxxxxxxx", "api_type" : "OpenAI", "base_url" : "https://api-ap-southeast-1.modelarts-maas.com/v2", "model_id" : "gpt-4o-mini" } ``` #### 响应示例 **状态码：200** 操作成功。 ``` { "provider_id" : "provider-uuid-001", "success" : true, "message" : "供应商连通性验证通过" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 操作成功。 | | 400 | 由于包含语法错误，当前请求无法被服务器理解。 | | 401 | 鉴权失败。 | | 403 | 没有操作权限。 | | 422 | 验证失败。 | | 500 | 服务内部异常。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。