DescribeVendorApiList - Security Center - Alibaba Cloud Documentation 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.

Queries the API operations of a cloud service provider.

Operation description

Please ensure that you fully understand the billing method and pricing of the response orchestration product (i.e., threat analysis and response log access traffic) before using this interface.

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:DescribeVendorApiList	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The current page number for pagination. The default value is 1.	1
PageSize	long	No	The number of items per page when displaying paginated results. The default is 10.	10
KeyWord	string	No	Keyword.	Create
ProductCode	string	No	Vendor's product identifier: waf: Web Application Firewall. cfw: Cloud Firewall.	waf
ApiName	string	No	The name of the Alibaba Cloud product interface, supporting fuzzy search.	AddAssetCleanConfig
VendorCode	string	No	Vendor code: Tencent: Tencent. HUAWEICLOUD: Huawei. Azure: Microsoft Azure. AWS: Amazon Web Services. Chaitin: Chaitin.	Azure

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request, and can be used to troubleshoot and locate issues.	E7698CFB-****-5840-8EC9-691B86729E94
Page	object	Pagination query information.
TotalCount	long	Total number of items.	100
PageNumber	long	The current page number in the pagination query.	1
PageSize	integer	The number of items displayed per page in the pagination query.	10
ApiList	array<object>	Product information.
Data	object	Product information.
VendorCode	string	Vendor code: Tencent: Tencent. HUAWEICLOUD: Huawei. Azure: Microsoft Azure. AWS: Amazon Web Services. Chaitin: Chaitin.	Azure
ProductCode	string	Vendor's product identifier: waf: Web Application Firewall. cfw: Cloud Firewall.	cfw
ProductName	string	Product name.	waf
Parameter	string	Interface request parameter configuration information.	[ { "name": "Domain", "type": "String", "isRequired": true, "exampleValue": "www.*.com", "description": "www.*.com" } ]
ProductDomain	string	Default domain of the product.	cfw.xxx.com
Protocol	string	Request protocol. Values: http: HTTP request protocol. https: HTTPS request protocol.	https
Method	string	Request methods: POST: POST request method. GET: GET request method. PUT: PUT request method. DELETE: DELETE request method.	POST
ApiName	string	The name of the vendor's API.	VerifyMobile
NeedPageInfo	boolean	Indicates whether pagination is needed. true: Yes. false: No.	false
PageInfo	string	Information displayed on the page.	{'Count': 10, 'TotalCount': 23, 'PageSize': 10, 'CurrentPage': 1}
ApiVersion	string	The version number of the API.	2017-08-01
NeedAdvanceConfig	boolean	Indicates whether advanced configuration is included. true: Yes. false: No.	true
AdvanceConfig	string	Advanced configuration for the API.	{ "cmd": "DescribeAclApiDispatch" }

Examples

Sample success responses

JSONformat

{
  "RequestId": "E7698CFB-****-5840-8EC9-691B86729E94",
  "Page": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10
  },
  "ApiList": [
    {
      "VendorCode": "Azure",
      "ProductCode": "cfw",
      "ProductName": "waf",
      "Parameter": [
        {
          "name": "Domain",
          "type": "String",
          "isRequired": true,
          "exampleValue": "www.***.com",
          "description": "www.***.com"
        }
      ],
      "ProductDomain": "cfw.xxx.com",
      "Protocol": "https",
      "Method": "POST",
      "ApiName": "VerifyMobile",
      "NeedPageInfo": false,
      "PageInfo": "{'Count': 10, 'TotalCount': 23, 'PageSize': 10, 'CurrentPage': 1}",
      "ApiVersion": "2017-08-01",
      "NeedAdvanceConfig": true,
      "AdvanceConfig": {
        "cmd": "DescribeAclApiDispatch"
      }
    }
  ]
}

Error codes

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