# 搜索连接器列表 - ListConnectors #### 功能介绍 搜索连接器列表 #### 调用方法 请参见[如何调用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 POST /v1/{project_id}/workspaces/{workspace_id}/soc/connectors/search 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，用于明确项目归属，配置后可通过该ID查询项目下连接器，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | workspace_id | 是 | String | **参数解释：** 工作空间id。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Language | 是 | String | **参数解释：** 语言，参考值：zh-cn、en-us **约束限制：** 不涉及 **取值范围：** zh-cn：中文环境 en-us：英文环境 **默认取值：** 不涉及 | | X-Auth-Token | 是 | String | **参数解释：** 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。[获取用户Token](https://support.huaweicloud.com/api-secmaster/secmaster_03_0010.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | Content-Type | 是 | String | **参数解释：** 内容类型 - application/json;charset=UTF-8 普通API请求的类型 **约束限制：** 不涉及 **取值范围：** - application/json;charset=UTF-8 **默认取值：** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释：** 分页大小 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | offset | 否 | Integer | **参数解释：** 偏移量 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | sort_by | 否 | String | **参数解释：** 排序字段：create_time \| update_time **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | order | 否 | String | **参数解释：** 排序方式：DESC \| ASC **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | id | 否 | String | **参数解释：** 连接器ID **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | src_provider_id | 否 | String | **参数解释：** 源产品ID **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | dst_provider_id | 否 | String | **参数解释：** 目的产品ID **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | src_provider_name | 否 | String | **参数解释：** 源产品名称 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | dst_provider_name | 否 | String | **参数解释：** 目的产品名称 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | name | 否 | String | **参数解释：** 连接器名称 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | connector_type | 否 | String | **参数解释：** 来源类型（SYSTEM/CUSTOM） **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | deploy_status | 否 | String | **参数解释：** 部署状态 **约束限制：** 不涉及 **取值范围：** - NOT_DEPLOYED：未部署 - DEPLOYING：部署中 - DEPLOYED：已部署 - UNINSTALLING：卸载中 - INSTALL_FAILED：安装失败 - UNINSTALL_FAILED：卸载失败 **默认取值：** 不涉及 | | run_status | 否 | String | **参数解释：** 运行状态 **约束限制：** 不涉及 **取值范围：** - NORMAL：正常 - ABNORMAL：异常 - STOPPED：未运行 **默认取值：** 不涉及 | | create_time_start | 否 | String | **参数解释：** 创建时间起始，格式ISO8601 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | create_time_end | 否 | String | **参数解释：** 创建时间结束，格式ISO8601 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释：** 请求响应码 **取值范围：** 不涉及 | | message | String | **参数解释：** 请求描述 **取值范围：** 不涉及 | | total | Integer | **参数解释：** 连接器总数 **取值范围：** 不涉及 | | limit | Integer | **参数解释：** 分页大小 **取值范围：** 不涉及 | | offset | Integer | **参数解释：** 偏移量 **取值范围：** 不涉及 | | success | Boolean | **参数解释：** 是否成功 **取值范围：** - true：是 - false：否 | | data | Array of [ConnectorDetail] objects | **参数解释：** 连接器列表 **取值范围：** 不涉及 | 表5ConnectorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 连接器ID **取值范围：** 不涉及 | | is_deleted | Boolean | **参数解释：** 是否删除 **取值范围：** - true：是 - false：否 | | name | String | **参数解释：** 连接器名称 **取值范围：** 不涉及 | | description | String | **参数解释：** 连接器描述 **取值范围：** 不涉及 | | domain_id | String | **参数解释：** workspace归属的账号ID **取值范围：** 不涉及 | | domain_name | String | **参数解释：** workspace归属的账号名称 **取值范围：** 不涉及 | | region_id | String | **参数解释：** workspace归属的账号名称的region_id **取值范围：** 不涉及 | | region_name | String | **参数解释：** workspace归属的账号名称的region_name **取值范围：** 不涉及 | | project_id | String | **参数解释：** workspace归属的项目id **取值范围：** 不涉及 | | workspace_id | String | **参数解释：** 当前的工作空间id **取值范围：** 不涉及 | | runner_type | String | **参数解释：** 连接器类型 **取值范围：** 不涉及 | | src_provider_id | String | **参数解释：** 源产品唯一标识 **取值范围：** 不涉及 | | src_provider_name | String | **参数解释：** 源产品名称 **取值范围：** 不涉及 | | src_desc | String | **参数解释：** 源产品描述 **取值范围：** 不涉及 | | dst_provider_id | String | **参数解释：** 目的产品唯一标识 **取值范围：** 不涉及 | | dst_provider_name | String | **参数解释：** 目的产品名称 **取值范围：** 不涉及 | | dst_desc | String | **参数解释：** 目的产品描述 **取值范围：** 不涉及 | | create_time | String | **参数解释：** 记录时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 **取值范围：** 不涉及 | | update_time | String | **参数解释：** 更新时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为告警发生时区，无法解析时区的时间，默认时区填东八区 **取值范围：** 不涉及 | | tags | String | **参数解释：** 标签，连接器标签，当前内置连接器默认为资产，支持自定义 **取值范围：** 不涉及 | | run_type | String | **参数解释：** 运行器类型 **取值范围：** 不涉及 | | attachment_id | String | **参数解释：** 附件ID **取值范围：** 不涉及 | | connection_params | String | **参数解释：** 连接参数(JSON格式，可选) **取值范围：** 不涉及 | | creator_id | String | **参数解释：** 创建者ID **取值范围：** 不涉及 | | creator_name | String | **参数解释：** 创建者名称 **取值范围：** 不涉及 | | modifier_id | String | **参数解释：** 修改者ID **取值范围：** 不涉及 | | modifier_name | String | **参数解释：** 修改者名称 **取值范围：** 不涉及 | | version | String | **参数解释：** 连接器的版本，v25.8.0，当前版本固定为latest, 有新版本时，将上一个版本发布为上个版本号 **取值范围：** 不涉及 | | meta_info | String | **参数解释：** 连接器元数据，元数据，如果没有设置，则默认为构建产物中的yaml配置，如果有设置，则更新设置的属性值。参考：functiongraph，meta_data对象 **取值范围：** 不涉及 | | trigger_info | String | **参数解释：** 触发器信息，像config连接器需要dms kafka触发器，像定义的timer触发器, 参考：functiongraph trigger **取值范围：** 不涉及 | | deploy_info | String | **参数解释：** 部署信息，Json结构，调用时根据部署信息进行联动。例如是FG时, 参考：fg function对象 **取值范围：** 不涉及 | | deploy_status | String | **参数解释：** 连接器部署状态 **取值范围：** - NOT_DEPLOYED：未部署 - DEPLOYING：部署中 - DEPLOYED：已部署 - UNINSTALLING：卸载中 - INSTALL_FAILED：安装失败 - UNINSTALL_FAILED：卸载失败 | | run_status | String | **参数解释：** 连接器实例的运行状态 **取值范围：** - NORMAL：正常 - ABNORMAL：异常 - STOPPED：未运行 | | zh_name | String | **参数解释：** 连接器中文名称 **取值范围：** 不涉及 | | en_name | String | **参数解释：** 连接器英文名称 **取值范围：** 不涉及 | | zh_description | String | **参数解释：** 连接器中文描述 **取值范围：** 不涉及 | | en_description | String | **参数解释：** 连接器英文描述 **取值范围：** 不涉及 | | runner_id | String | **参数解释：** 执行引擎实例ID（如FunctionGraph函数URN） **取值范围：** 不涉及 | | runner_name | String | **参数解释：** 执行引擎实例名称 **取值范围：** 不涉及 | | connector_type | String | **参数解释：** 来源类型（SYSTEM/CUSTOM） **取值范围：** 不涉及 | | is_built_in | Boolean | **参数解释：** 是否内置 **取值范围：** - true：是 - false：否 | | datalinks | Array of [DataLink] objects | **参数解释：** 连接器连接列表 **取值范围：** 不涉及 | 表6DataLink | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 连接器连接唯一标识 **取值范围：** 不涉及 | | connector_id | String | **参数解释：** 连接器ID **取值范围：** 不涉及 | | name | String | **参数解释：** 连接器连接名称 **取值范围：** 不涉及 | | zh_name | String | **参数解释：** 连接器连接中文名称 **取值范围：** 不涉及 | | en_name | String | **参数解释：** 连接器连接英文名称 **取值范围：** 不涉及 | | src_asset_id | String | **参数解释：** 源端凭据ID **取值范围：** 不涉及 | | src_scope | String | **参数解释：** 源端范围 **取值范围：** 不涉及 | | dst_asset_id | String | **参数解释：** 目的端凭据ID **取值范围：** 不涉及 | | dst_scope | String | **参数解释：** 目的端范围 **取值范围：** 不涉及 | | src_dataset_id | String | **参数解释：** 源端数据集ID **取值范围：** 不涉及 | | dst_dataset_id | String | **参数解释：** 目的端数据集ID **取值范围：** 不涉及 | | src_dataset_desc | String | **参数解释：** 源端描述 **取值范围：** 不涉及 | | zh_src_dataset_desc | String | **参数解释：** 源端描述（中文） **取值范围：** 不涉及 | | en_src_dataset_desc | String | **参数解释：** 源端描述（英文） **取值范围：** 不涉及 | | dst_dataset_desc | String | **参数解释：** 目的端描述 **取值范围：** 不涉及 | | zh_dst_dataset_desc | String | **参数解释：** 目的端描述（中文） **取值范围：** 不涉及 | | en_dst_dataset_desc | String | **参数解释：** 目的端描述（英文） **取值范围：** 不涉及 | | extend_params | String | **参数解释：** 运行时参数(JSON格式) **取值范围：** 不涉及 | | run_status | String | **参数解释：** 运行状态 **取值范围：** - NORMAL：正常 - ABNORMAL：异常 - STOPPED：未运行 | | create_time | String | **参数解释：** 创建时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 **取值范围：** 不涉及 | | update_time | String | **参数解释：** 更新时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 **取值范围：** 不涉及 | | creator_id | String | **参数解释：** 创建者ID **取值范围：** 不涉及 | | creator_name | String | **参数解释：** 创建者名称 **取值范围：** 不涉及 | | modifier_id | String | **参数解释：** 修改者ID **取值范围：** 不涉及 | | modifier_name | String | **参数解释：** 修改者名称 **取值范围：** 不涉及 | **状态码：400** 表7响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-request-id | String | **参数解释：** 请求ID **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释：** 请求响应码 **取值范围：** 不涉及 | | message | String | **参数解释：** 请求描述 **取值范围：** 不涉及 | #### 请求示例 搜索连接器列表的请求样例 ``` https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/connectors/search { "limit" : 10, "offset" : 0, "sort_by" : "create_time", "order" : "DESC", "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "src_provider_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "dst_provider_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "src_provider_name" : "A云WAF", "dst_provider_name" : "B云WAF" } ``` #### 响应示例 **状态码：200** ``` { "code" : "SecMaster.00000000", "message" : "Parameter error.", "total" : 100000, "limit" : 1000, "offset" : 1000000, "success" : true, "data" : [ { "id" : "cae09c05-2e17-4ccb-96a6-b2edeb9f5394", "is_deleted" : true, "name" : "连接器1", "description" : "**参数解释：**\n连接器1的描述\n**约束限制：**\n不涉及\n**取值范围：**\n不涉及\n**默认取值：**\n不涉及", "domain_id" : "909494e3-558e-46b6-a9eb-07a8e18ca622", "domain_name" : "staff_xxx_123", "region_id" : "909494e3-558e-46b6-a9eb-07a8e18ca623", "region_name" : "cn-north-4", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca623", "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca624", "src_provider_id" : "909494e3-558e-46b6-a9eb-07a8e18ca623", "src_provider_name" : "909494e3-558e-46b6-a9eb-07a8e18ca623", "dst_provider_id" : "909494e3-558e-46b6-a9eb-07a8e18ca623", "dst_provider_name" : "909494e3-558e-46b6-a9eb-07a8e18ca623", "create_time" : "2023-02-27 20:28:53.001000+08:00", "update_time" : "2023-02-27 20:28:53.001000+08:00", "tags" : "内部", "run_type" : "运行器", "attachment_id" : "909494e3-558e-46b6-a9eb-07a8e18ca624", "creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca624", "creator_name" : "用户1", "modifier_id" : "909494e3-558e-46b6-a9eb-07a8e18ca624", "modifier_name" : "用户1", "version" : "v25.8.0", "meta_info" : "{\"app_xrole\": \"serverless-trust\", \"custom_image\": {\"enabled\": false, \"image\": \"\", \"command\": \"\", \"args\": \"\", \"working_dir\": \"\", \"uid\": \"\", \"gid\": \"\", \"port\": \"\"}, \"domain_names\": \"\", \"enable_dynamic_memory\": false, \"enterprise_project_id\": \"0\", \"func_vpc\": {\"cidr\": \"10.75.193.0/24\", \"gateway\": \"10.75.193.1\", \"subnet_name\": \"az1-dmz01\", \"subnet_id\": \"375c64b6-d718-4273-9ed3-e90369e78a93\", \"vpc_name\": \"DMZ-VPC01\", \"vpc_id\": \"73c77bd9-cec9-4baf-bb12-8fc3ca29dc85\", \"ipv6_enable\": false, \"security_groups\": [\"\"], \"is_safety\": true}, \"func_name\": \"demo-1\", \"handler\": \"index.handler\", \"memory_size\": 128, \"runtime\": \"Python3.9\", \"user_data\": \"{\\\"env1\\\":\\\"1\\\"}\", \"timeout\": 3, \"description\": \"121212121\", \"xrole\": \"serverless-trust\", \"is_stateful_function\": true, \"network_controller\": {\"disable_public_network\": false, \"public_bandwidth\": \"\", \"trigger_access_vpcs\": null}, \"ephemeral_storage\": 512, \"heartbeat_handler\": \"index.py\", \"custom_health_check_config\": {\"http_get_url\": \"\", \"initial_delay_seconds\": 0, \"period_seconds\": 0, \"timeout_seconds\": 0, \"failure_threshold\": 0, \"success_threshold\": 0}, \"enable_custom_rpc\": false, \"status\": 0, \"strategy_config\": {\"concurrency\": 100, \"concurrent_num\": 1}, \"stream_response\": false, \"dns_config\": {\"dns\": [], \"dns_opts\": [], \"dns_search\": []}, \"initializer_timeout\": 3, \"initializer_handler\": \"index.py\" \"enable_lts_log\": true, \"log_config\": {\"group_id\": \"7c458857-84ab-41c2-8a62-666e07ba2f81\", \"group_name\": \"beta\", \"stream_name\": \"functiongraph-topic-lzh\", \"stream_id\": \"ab76b794-cb5c-4942-b51a-1a3819783106\"}, \"mount_config\": {\"mount_user\": {\"user_id\": -1, \"user_group_id\": -1}, \"func_mounts\": [{\"mount_resource\": \"rf-service-provider-plugin\", \"local_mount_path\": \"/mnt\", \"mount_type\": \"sfs3.0\"}]}}", "trigger_info" : "{\"trigger_id\": \"8c147db6-9a33-491e-9499-12a49cf5782f\", \"trigger_type_code\": \"TIMER\", \"trigger_status\": \"ACTIVE\", \"event_data\": {\"name\": \"Timer-dssc\", \"schedule\": \"3m\", \"schedule_type\": \"Rate\", \"sync_execution\": false}, \"last_updated_time\": \"2025-05-01T10:02:19+02:00\", \"created_time\": \"2025-05-01T10:02:19+02:00\", \"func_urn\": \"urn:fss:cn-north-7:15645222e8744afa985c93dab6341da6:function:default:Sync_SecMaster_DataObject:latest\"}", "deploy_info" : "{\"resource_id\": \"98161fb8-1c8b-4852-8f8c-a78cfbfffe2e.TestAsume\", \"func_urn\": \"urn:fss:cn-north-7:15645222e8744afa985c93dab6341da6:function:default:TestAsume\", \"func_name\": \"TestAsume\", \"domain_id\": \"ac7438b990ef4a37b741004eb45e8bf4\", \"namespace\": \"15645222e8744afa985c93dab6341da6\", \"project_name\": \"cn-north-4\", \"package\": \"default\", \"runtime\": \"Python3.9\", \"timeout\": 3, \"handler\": \"index.handler\", \"memory_size\": 128, \"cpu\": 300, \"code_type\": \"inline\", \"code_filename\": \"index.zip\", \"code_size\": 362, \"digest\": \"8905b85cc16bccfdb64c2be30dc586cd9ea14ce40b9e3705e3c238275fd0279eaf4d7efa1fba79ea5c989e491b753d31b5e977d60d9a9e3c211b548191ac68f3\", \"version\": \"latest\", \"image_name\": \"latest-260128100753@ovoi6\", \"xrole\": \"TestAsume\", \"app_xrole\": \"TestAsume\", \"last_modified\": \"2026-01-28T10:07:53+08:00\", \"strategy_config\": {\"concurrency\": 100, \"concurrent_num\": 1}}", "deploy_status" : null, "run_status" : "NORMAL", "datalinks" : [ { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca621", "connector_id" : "909494e3-558e-46b6-a9eb-07a8e18ca621", "src_dataset_id" : "909494e3-558e-46b6-a9eb-07a8e18ca621", "src_dataset_desc" : "链接", "src_asset_id" : "909494e3558e46b6-a9eb07a8e18ca621", "dst_dataset_id" : "909494e3-558e-46b6-a9eb-07a8e18ca621", "dst_dataset_desc" : "909494e3-558e-46b6-a9eb-07a8e18ca621", "dst_asset_id" : "909494e3558e46b6-a9eb07a8e18ca621", "update_time" : "2023-02-27 20:28:53.001000+08:00", "modifier_id" : "909494e3-558e-46b6-a9eb-07a8e18ca621", "modifier_name" : "用户1", "run_status" : "NORMAL" } ] } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 搜索连接器列表返回body体 | | 400 | 响应错误返回对象 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。