更新时间:2026-09-24 GMT+08:00
分享

更新产品 - UpdateProvider

功能介绍

更新产品

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。

URI

PUT /v1/{project_id}/workspaces/{workspace_id}/soc/providers/{provider_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

只能由英文字母、数字组成,且长度为32~64个字符。

默认取值:

不涉及

workspace_id

是

String

参数解释:

工作空间ID,用于明确工作空间归属,配置后可通过该ID查询工作空间下资产,可以通过调用API获取,也可以从控制台获取。

约束限制:

不涉及

取值范围:

只能由英文字母、数字、中划线组成,UUID格式,且长度为32~64个字符。

默认取值:

不涉及

provider_id

是

String

参数解释:

产品ID,用于唯一标识一个产品。

约束限制:

不涉及

取值范围:

只能由英文字母、数字、中划线组成,UUID格式,且长度为32~64个字符。

默认取值:

不涉及

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

name

否

String

参数解释:

产品名称,用于标识产品。

约束限制:

不涉及

取值范围:

只能由英文字母、数字、中文、下划线、中划线、点号组成,且长度为1~64个字符。

默认取值:

不涉及

code

否

String

参数解释:

产品编码,用于唯一标识产品编码。

约束限制:

不涉及

取值范围:

只能由英文字母、数字、中文、下划线、中划线、点号组成,且长度为1~64个字符。

默认取值:

不涉及

description

否

String

参数解释:

产品描述,用于描述产品的详细信息。

约束限制:

不涉及

取值范围:

长度为0~2048个字符。

默认取值:

不涉及

logo

否

String

参数解释:

产品标志,用于展示产品的Logo图片。

约束限制:

不涉及

取值范围:

Base64编码图片,格式为data:image/(png|jpeg|gif|x-icon);base64,<base64数据>,且长度为0~65536个字符。

默认取值:

不涉及

响应参数

状态码:200

表3 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释:

请求ID,用于任务追踪。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表4 响应Body参数

参数

参数类型

描述

code

String

参数解释:

响应码,用于标识请求是否成功。

取值范围:

  • 00000000:成功

message

String

参数解释:

响应消息,用于返回操作提示信息。

取值范围:

长度为0~1024个字符。

request_id

String

参数解释:

请求ID,用于唯一标识一次请求,便于问题追踪。

取值范围:

UUID格式,且长度为0~128个字符。

success

Boolean

参数解释:

是否成功,用于标识请求是否处理成功。

取值范围:

  • true:成功

  • false:失败

data

ProviderResponseBody object

参数解释:

产品数据,用于返回产品详细信息。

取值范围:

不涉及

表5 ProviderResponseBody

参数

参数类型

描述

id

String

参数解释:

产品ID,用于唯一标识一个产品。

取值范围:

只能由英文字母、数字、中划线组成,UUID格式,且长度为32~64个字符。

project_id

String

参数解释:

项目ID,用于明确项目归属。

取值范围:

只能由英文字母、数字组成,且长度为32~64个字符。

workspace_id

String

参数解释:

工作空间ID,用于明确工作空间归属。

取值范围:

只能由英文字母、数字、中划线组成,UUID格式,且长度为32~64个字符。

name

String

参数解释:

产品名称,用于标识产品。

取值范围:

只能由英文字母、数字、中文、下划线、中划线、点号组成,且长度为1~64个字符。

code

String

参数解释:

产品编码,用于唯一标识产品编码。

取值范围:

只能由英文字母、数字、中文、下划线、中划线、点号组成,且长度为1~64个字符。

vendor_id

String

参数解释:

厂商ID,用于指定产品所属的厂商。

取值范围:

只能由英文字母、数字、中划线组成,UUID格式,且长度为32~64个字符。

vendor_name

String

参数解释:

厂商名称,用于标识产品所属厂商的名称。

取值范围:

只能由英文字母、数字、中文、下划线、中划线、点号组成,且长度为0~64个字符。

vendor_code

String

参数解释:

厂商编码,用于标识产品所属厂商的编码。

取值范围:

只能由英文字母、数字、中文、下划线、中划线、点号组成,且长度为0~64个字符。

description

String

参数解释:

产品描述,用于描述产品的详细信息。

取值范围:

长度为0~2048个字符。

logo

String

参数解释:

产品标志,用于展示产品的Logo图片。

取值范围:

Base64编码图片,格式为data:image/(png|jpeg|gif|x-icon);base64,<base64数据>,且长度为0~65536个字符。

creator_id

String

参数解释:

创建者ID,用于标识创建该产品的用户。

取值范围:

只能由英文字母、数字、中划线组成,且长度为0~64个字符。

creator_name

String

参数解释:

创建者名称,用于标识创建该产品的用户名称。

取值范围:

只能由英文字母、数字、中文、下划线、中划线、点号组成,且长度为0~64个字符。

create_time

String

参数解释:

创建时间,用于记录产品的创建时间。使用UTC+8时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSS+08:00。

取值范围:

不涉及

modifier_id

String

参数解释:

修改者ID,用于标识最近修改该产品的用户。

取值范围:

只能由英文字母、数字、中划线组成,且长度为0~64个字符。

modifier_name

String

参数解释:

修改者名称,用于标识最近修改该产品的用户名称。

取值范围:

只能由英文字母、数字、中文、下划线、中划线、点号组成,且长度为0~64个字符。

update_time

String

参数解释:

更新时间,用于记录产品的最近更新时间。使用UTC+8时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSS+08:00。

取值范围:

不涉及

is_deleted

Boolean

参数解释:

是否已删除,用于标识产品是否已被删除。

取值范围:

  • true:已删除

  • false:未删除

状态码:400

表6 响应Header参数

参数

参数类型

描述

X-request-id

String

参数解释:

请求ID,用于任务追踪。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,用于标识错误类型。

取值范围:

只能由英文字母、数字、点号组成,且长度为0~64个字符。

error_msg

String

参数解释:

错误描述,用于描述错误的详细信息。

取值范围:

长度为0~1024个字符。

请求示例

在某个工作空间更新一个产品的请求样例

https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/providers/{provider_id}

{
  "name" : "demo_provider_updated",
  "code" : "P001",
  "description" : "更新后的产品"
}

响应示例

状态码:200

{
  "code" : "00000000",
  "message" : "",
  "data" : {
    "id" : "28f61af50fc9452aa0ed5ea25c3cc3d3",
    "project_id" : "684fc87a79d7471583df22e62a7da95b",
    "workspace_id" : "441d5677-b76a-4dd4-a97a-ef7fd6336666",
    "name" : "demo_provider_updated",
    "code" : "P001",
    "vendor_id" : "28f61af50fc9452aa0ed5ea25c3cc3d3",
    "vendor_name" : "demo_vendor",
    "vendor_code" : "V001",
    "description" : "更新后的产品",
    "logo" : "",
    "creator_id" : "b4e5a6f7c8d9e0f1a2b3c4d5e6f7a8b9",
    "creator_name" : "l0******",
    "create_time" : "2026-07-02T18:05:21.975+08:00",
    "modifier_id" : "b4e5a6f7c8d9e0f1a2b3c4d5e6f7a8b9",
    "modifier_name" : "l0******",
    "update_time" : "2026-07-02T18:10:00.543+08:00",
    "is_deleted" : false
  },
  "request_id" : "",
  "success" : true
}

状态码

状态码

描述

200

产品信息

400

错误响应

错误码

请参见错误码。

相关文档