DescribeVendorApiList - 查询多云厂商的OpenApi列表

查询云厂商OpenApi列表。

接口说明

请确保在使用该接口前,已充分了解响应编排产品(即威胁分析与响应日志接入流量)的收费方式和价格

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
PageNumberinteger

当前分页的页码数。默认值为 1。

1
PageSizelong

分页展示时,每个分页包含的列表条目数。默认为 10。

10
KeyWordstring

关键字。

Create
ProductCodestring

厂商的产品标识:

  • waf: Web 应用防火墙。
  • cfw :云防火墙。
waf
ApiNamestring

阿里云产品接口的名称,支持模糊搜索。

AddAssetCleanConfig
VendorCodestring

厂商 code:

  • Tencent :腾讯。
  • HUAWEICLOUD: 华为。
  • Azure :微软云。
  • AWS :亚马逊云。
  • Chaitin :长亭。
Azure

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

E7698CFB-****-5840-8EC9-691B86729E94
Pageobject

分页查询信息。

TotalCountlong

总条数。

100
PageNumberlong

分页查询时,当前页的页码。

1
PageSizeinteger

分页查询时,每页显示的条目数量。

10
ApiListarray<object>

产品信息。

Dataobject

产品信息。

VendorCodestring

厂商 code:

  • Tencent :腾讯。
  • HUAWEICLOUD: 华为。
  • Azure :微软云。
  • AWS :亚马逊云。
  • Chaitin :长亭。
Azure
ProductCodestring

厂商的产品标识:

  • waf: Web 应用防火墙。
  • cfw :云防火墙。
cfw
ProductNamestring

产品名称。

waf
Parameterstring

接口请求参数配置信息。

[ { "name": "Domain", "type": "String", "isRequired": true, "exampleValue": "www.***.com", "description": "www.***.com" } ]
ProductDomainstring

产品默认的域名。

cfw.xxx.com
Protocolstring

请求协议。取值:

  • http: HTTP 请求协议。
  • https:HTTPS 请求协议。
https
Methodstring

请求方式:

  • POST: POST 请求方式。
  • GET:GET 请求方式。
  • PUT: PUT 请求方式。
  • DELETE: DELETE 请求方式。
POST
ApiNamestring

厂商的接口名称。

VerifyMobile
NeedPageInfoboolean

是否翻页。

  • true:是。
  • false:否。
false
PageInfostring

页面显示的信息。

{'Count': 10, 'TotalCount': 23, 'PageSize': 10, 'CurrentPage': 1}
ApiVersionstring

API 的版本号。

2017-08-01
NeedAdvanceConfigboolean

是包含高级配置。

  • true: 是。
  • false: 否。
true
AdvanceConfigstring

接口高级配置。

{ "cmd": "DescribeAclApiDispatch" }

示例

正常返回示例

JSON格式

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

错误码

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