通過API擷取雲廠商產品模板配置 - Security Center

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-sas:DescribeCloudVendorProductTemplateConfig

get

*全部資源

*

無

請求文法

POST  HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
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\\\"}]}]}]}"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。