Retrieve Cloud Vendor Product Template Config via API - Security Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Get the cloud product access template for vendors

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:DescribeCloudVendorProductTemplateConfig	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Vendor	string	No	Cloud asset vendor. Values: CHAITIN: Chaitin Technology FORTINET: Fortinet THREATBOOK: ThreatBook	CHAITIN
Lang	string	No	Set the language type for request and response messages, default is zh. Values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	Request return data.
RequestId	string	The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request, and can be used to troubleshoot and locate issues.	CD380235-A0B8-540D-A0D5-D6288446****
Data	string	Template configuration. This parameter is a JSON structure that includes the following fields: - vendors: A collection of vendor template configuration information. - vendorType: Vendor code, CHAITIN takes the value 100, FORTINET takes the value 101, and THREATBOOK takes the value 102. - vendor: Vendor. Takes the values CHAITIN, FORTINET, or THREATBOOK. - displayName: Display name. Takes the values Chaitin, Fortinet, or Threatbook. - products: A list of template configuration information. This parameter is a JSON structure that includes the following fields: - product: Product code. When vendor is CHAITIN, it takes the value webFirewall; when vendor is FORTINET, it takes the value fortigate; when vendor is THREATBOOK, it takes the value threatIntelligence. - displayName: Product display name. When vendor is CHAITIN, it takes the value WAF; when vendor is FORTINET, it takes the value FortiGate Firewall; when vendor is THREATBOOK, it takes the value Threat Intelligence API. - description: Link to the technical support document for the product. - backendConfig: A list of API field mapping rules. This parameter is a JSON structure that includes the following fields: - apiParams: API field mapping rules. This parameter is a Map structure where the key is the backend field mapping key. The value is a JSON structure that includes the following fields: - field: Property key. - format: Type of the property value, which can be text or json. - fields: Fields that need to be filled in the template. This parameter is a JSON structure that includes the following fields: - displayName: Field display name. - editable: Whether the field is editable. Takes the values true or false. true means editable, false means not editable. - fieldType: Type of the field value. Takes the values text or password. - required: Whether the field is required. Takes the values true or false. true means required, false means not required. - fieldId: Field 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\"}]}]}]}

Examples

Sample success responses

JSONformat

{
  "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\\\"}]}]}]}"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2025-12-09	Add Operation	View Change Details