# 搜索产品列表 - ListProviders #### 功能介绍 搜索产品列表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-secmaster/secmaster_03_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-secmaster/secmaster_03_0023.html)。 #### URI GET /v1/{project_id}/workspaces/{workspace_id}/soc/providers 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制：** 不涉及 **取值范围：** 只能由英文字母、数字组成，且长度为32\~64个字符。 **默认取值：** 不涉及 | | workspace_id | 是 | String | **参数解释：** 工作空间ID，用于明确工作空间归属，配置后可通过该ID查询工作空间下资产，可以通过调用API获取，也可以从控制台获取。 **约束限制：** 不涉及 **取值范围：** 只能由英文字母、数字、中划线组成，UUID格式，且长度为32\~64个字符。 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释：** 厂商名称，用于按名称搜索厂商。 **约束限制：** 不涉及 **取值范围：** 只能由英文字母、数字、中文、下划线、中划线、点号组成，且长度为0\~64个字符。 **默认取值：** 不涉及 | | code | 否 | String | **参数解释：** 厂商编码，用于按编码搜索厂商。 **约束限制：** 不涉及 **取值范围：** 只能由英文字母、数字、中文、下划线、中划线、点号组成，且长度为0\~64个字符。 **默认取值：** 不涉及 | | vendor_id | 否 | String | **参数解释：** 厂商ID，用于按厂商筛选产品列表。 **约束限制：** 不涉及 **取值范围：** 只能由英文字母、数字、中划线组成，UUID格式，且长度为32\~64个字符。 **默认取值：** 不涉及 | | ids | 否 | String | **参数解释：** 厂商ID列表，用于按ID批量查询，多个ID以逗号分隔。 **约束限制：** 不涉及 **取值范围：** 只能由英文字母、数字、中划线组成，UUID格式，以逗号分隔，且长度为0\~1024个字符。 **默认取值：** 不涉及 | | from_date | 否 | String | **参数解释：** 开始时间，用于筛选创建时间大于等于该时间的数据。 **约束限制：** 开始时间和结束时间必须同时设置。 **取值范围：** UTC时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ，例如2026-07-02T18:05:21.975+08:00。 **默认取值：** 不涉及 | | to_date | 否 | String | **参数解释：** 结束时间，用于筛选创建时间小于等于该时间的数据。 **约束限制：** 开始时间和结束时间必须同时设置。 **取值范围：** UTC时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ，例如2026-07-02T18:05:21.975+08:00。 **默认取值：** 不涉及 | | order | 否 | String | **参数解释：** 排序字段，用于指定列表的排序方式，格式为"排序字段:排序方向"，多字段排序以逗号分隔。 **约束限制：** 排序字段必须在可排序列范围内，排序方向仅支持asc和desc（不区分大小写），格式不符合要求的部分会被忽略。 **取值范围：** 排序字段： - name：名称 - create_time：创建时间 - update_time：更新时间 - asc：升序 - desc：降序 排序方向： **默认取值：** 不涉及 | | offset | 否 | Integer | **参数解释：** 偏移量，表示从该偏移量开始查询。 **约束限制：** 不涉及 **取值范围：** 0\~10000 **默认取值：** 0 | | limit | 否 | Integer | **参数解释：** 每页数量，表示每页返回的最大记录数。 **约束限制：** 不涉及 **取值范围：** 1\~1000 **默认取值：** 10 | #### 请求参数 无 #### 响应参数 **状态码：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 | Array of [ProviderListResponseBody] objects | **参数解释：** 产品列表数据。 **取值范围：** 0\~100条记录 | | total | Integer | **参数解释：** 符合条件的数据总数。 **取值范围：** 0\~10000 | | size | Integer | **参数解释：** 当前请求分页大小。 **取值范围：** 1\~1000 | | page | Integer | **参数解释：** 当前请求页数。 **取值范围：** 0\~999999999 | 表5ProviderListResponseBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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,\，且长度为0\~65536个字符。 | | creator_name | String | **参数解释：** 创建者名称，用于标识创建该产品的用户名称。 **取值范围：** 只能由英文字母、数字、中文、下划线、中划线、点号组成，且长度为0\~64个字符。 | | create_time | String | **参数解释：** 创建时间，用于记录产品的创建时间。使用UTC+8时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSS+08:00。 **取值范围：** 不涉及 | | update_time | String | **参数解释：** 更新时间，用于记录产品的最近更新时间。使用UTC+8时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSS+08:00。 **取值范围：** 不涉及 | **状态码：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 ``` #### 响应示例 **状态码：200** ``` { "code" : "00000000", "message" : "", "data" : [ { "id" : "28f61af50fc9452aa0ed5ea25c3cc3d3", "name" : "demo_provider", "code" : "P001", "vendor_id" : "28f61af50fc9452aa0ed5ea25c3cc3d3", "vendor_name" : "demo_vendor", "vendor_code" : "V001", "description" : "示例产品", "logo" : "", "creator_name" : "l0******", "create_time" : "2026-07-02T18:05:21.975+08:00", "update_time" : "2026-07-02T18:05:21.975+08:00" } ], "request_id" : "", "success" : true, "total" : 1, "size" : 10, "page" : 0 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 产品列表 | | 400 | 错误响应 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。