Retrieve Cloud Vendor Product Template Config via API - Security Center - Alibaba Cloud - Security Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:DescribeCloudVendorProductTemplateConfig

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Vendor	string	No	The cloud vendor. Valid values: CHAITIN: Chaitin Technology FORTINET: Fortinet THREATBOOK: ThreatBook	CHAITIN
Lang	string	No	The language of the request and response. Default value: zh. Valid values: zh: Chinese en: English	zh

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID. You can use this ID to troubleshoot issues.	CD380235-A0B8-540D-A0D5-D6288446****
Data	string	The template configuration in JSON format. The JSON structure includes the following fields: - vendors: The collection of vendor template configurations. - vendorType: The vendor code. CHAITIN takes the value 100, FORTINET takes the value 101, and THREATBOOK takes the value 102. - vendor: The vendor. Valid values: CHAITIN, FORTINET, and THREATBOOK. - displayName: The display name. Valid values: Chaitin, Fortinet, and Threatbook. - products: The list of product template configurations. This JSON structure includes the following fields: - product: The product code. When vendor is CHAITIN, the value is webFirewall; when vendor is FORTINET, the value is fortigate; when vendor is THREATBOOK, the value is threatIntelligence. - displayName: The product display name. When vendor is CHAITIN, the value is WAF; when vendor is FORTINET, the value is FortiGate Firewall; when vendor is THREATBOOK, the value is Threat Intelligence API. - description: The link to the technical support document for the product. - backendConfig: The list of API field mapping rules. This JSON structure includes the following fields: - apiParams: The API field mapping rules in a Map structure where the key is the backend field mapping key. The value is a JSON structure that includes the following fields: - field: The property key. - format: The type of the property value. Valid values: text and json. - fields: The fields to fill in the template. This JSON structure includes the following fields: - displayName: The field display name. - editable: Indicates whether the field is editable. Valid values: true and false. true indicates editable. false indicates not editable. - fieldType: The type of the field value. Valid values: text and password. - required: Indicates whether the field is required. Valid values: true and false. true indicates required. false indicates not required. - fieldId: The 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

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.