使用DescribeCloudVendorProductTemplateConfig查询CTDR云厂商产品接入模板配置-云安全中心-阿里云

多云配置管理用来查询CTDR云厂商产品接入模板配置。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-sas:DescribeCloudVendorProductTemplateConfig	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Vendor	string	否	云资产厂商。取值： CHAITIN：长亭科技 FORTINET：飞塔 THREATBOOK：微步在线	CHAITIN
Lang	string	否	设置请求和接收消息的语言类型，默认为 zh。取值： zh：中文 en：英文	zh

返回参数

名称	类型	描述	示例值
	object	请求返回数据。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	CD380235-A0B8-540D-A0D5-D6288446****
Data	string	模板配置。该参数为 JSON 结构，其中包含以下字段： vendors：厂商模板配置信息集合。 vendorType：厂商编号，CHAITIN 取值 100，FORTINET 取值 101，THREATBOOK 取值 102。 vendor：厂商。取值 CHAITIN 、FORTINET、THREATBOOK。 displayName：显示名。取值 Chaitin 、Fortinet、Threatbook。 products：模板配置信息列表。该参数为 JSON 结构，其中包含以下字段： product：产品码。vendor 为 CHAITIN 时取值 webFirewall，vendor 为 FORTINET 时取值 fortigate，vendor 为 THREATBOOK 时取值 threatIntelligence。 displayName：产品显示名称。vendor 为 CHAITIN 时取值 WAF，vendor 为 FORTINET 时取值FortiGate Firewall，vendor 为 THREATBOOK 时取值Threat Intelligence API。 description：产品对应技术支持文档链接。 backendConfig：API 字段映射规则列表。该参数为 JSON 结构，其中包含以下字段： apiParams：API 字段映射规则。该参数为 Map 结构，其中 Key 为对应提交的后端字段映射 Key。Value 为 JSON 结构，其中包含以下字段： field：属性 Key。 format：属性值对应的类型，取值为 text 和 json。 fields：模板需要填充的字段。该参数为 JSON 结构，其中包含以下字段： displayName：字段显示名称。 editable：字段是否可修改。取值为 true 和 false。true 为可修改，false 为不可修改。 fieldType：字段值对应的类型。取值为 text 和 password。 required：字段是否必填。取值为 true 和 false。true 为必填，false 为非必填。 fieldId：字段 Key。	{\"vendors\":[{\"vendorType\":100,\"vendor\":\"CHAITIN\",\"displayName\":\"Chaitin\",\"products\":[{\"product\":\"webFirewall\",\"displayName\":\"WAF\",\"backendConfig\":{\"apiParams\":{\"SecretKey\":{\"field\":\"apiToken\",\"format\":\"text\"},\"SecretId\":{\"field\":\"endpoint\",\"format\":\"text\"},\"Vendor\":{\"field\":\"vendor\",\"format\":\"text\"},\"CtdrCloudUserId\":{\"field\":\"ctdrCloudUserId\",\"format\":\"text\"},\"ExtendInfo\":{\"format\":\"json\",\"fields\":[\"product\",\"remark\"]}}},\"description\":\"https://docs.waf-ce.chaitin.cn/%E6%9B%B4%E5%A4%9A%E6%8A%80%E6%9C%AF%E6%96%87%E6%A1%A3/OPENAPI\",\"fields\":[{\"displayName\":\"Endpoint\",\"fieldType\":\"text\",\"prompt\":\"Enter an endpoint that is in the IP address:Port number format.\",\"required\":true,\"fieldId\":\"endpoint\"},{\"displayName\":\"API Token\",\"fieldType\":\"password\",\"required\":true,\"fieldId\":\"apiToken\"},{\"displayName\":\"‌Device Name‌ (The cloud_user_id field in the device connection logs will uniquely identify the device)\",\"fieldType\":\"text\",\"required\":true,\"fieldId\":\"ctdrCloudUserId\"},{\"displayName\":\"Remark\",\"fieldType\":\"text\",\"required\":false,\"fieldId\":\"remark\"}]}]}]}

示例

正常返回示例

JSON格式

{
  "RequestId": "CD380235-A0B8-540D-A0D5-D6288446****",
  "Data": "{\\\"vendors\\\":[{\\\"vendorType\\\":100,\\\"vendor\\\":\\\"CHAITIN\\\",\\\"displayName\\\":\\\"Chaitin\\\",\\\"products\\\":[{\\\"product\\\":\\\"webFirewall\\\",\\\"displayName\\\":\\\"WAF\\\",\\\"backendConfig\\\":{\\\"apiParams\\\":{\\\"SecretKey\\\":{\\\"field\\\":\\\"apiToken\\\",\\\"format\\\":\\\"text\\\"},\\\"SecretId\\\":{\\\"field\\\":\\\"endpoint\\\",\\\"format\\\":\\\"text\\\"},\\\"Vendor\\\":{\\\"field\\\":\\\"vendor\\\",\\\"format\\\":\\\"text\\\"},\\\"CtdrCloudUserId\\\":{\\\"field\\\":\\\"ctdrCloudUserId\\\",\\\"format\\\":\\\"text\\\"},\\\"ExtendInfo\\\":{\\\"format\\\":\\\"json\\\",\\\"fields\\\":[\\\"product\\\",\\\"remark\\\"]}}},\\\"description\\\":\\\"https://docs.waf-ce.chaitin.cn/%E6%9B%B4%E5%A4%9A%E6%8A%80%E6%9C%AF%E6%96%87%E6%A1%A3/OPENAPI\\\",\\\"fields\\\":[{\\\"displayName\\\":\\\"Endpoint\\\",\\\"fieldType\\\":\\\"text\\\",\\\"prompt\\\":\\\"Enter an endpoint that is in the IP address:Port number format.\\\",\\\"required\\\":true,\\\"fieldId\\\":\\\"endpoint\\\"},{\\\"displayName\\\":\\\"API Token\\\",\\\"fieldType\\\":\\\"password\\\",\\\"required\\\":true,\\\"fieldId\\\":\\\"apiToken\\\"},{\\\"displayName\\\":\\\"‌Device Name‌ (The cloud_user_id field in the device connection logs will uniquely identify the device)\\\",\\\"fieldType\\\":\\\"text\\\",\\\"required\\\":true,\\\"fieldId\\\":\\\"ctdrCloudUserId\\\"},{\\\"displayName\\\":\\\"Remark\\\",\\\"fieldType\\\":\\\"text\\\",\\\"required\\\":false,\\\"fieldId\\\":\\\"remark\\\"}]}]}]}"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2025-12-09	新增 OpenAPI	查看变更详情