主机安全创建白名单订单-设置中心相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： cwp.tencentcloudapi.com 。

该接口可以创建白名单订单

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateWhiteListOrder。
Version	是	String	公共参数，本接口取值：2018-02-28。
Region	否	String	公共参数，此参数为可选参数。
LicenseType	是	Integer	授权类型示例值：1
LicenseNum	是	Integer	授权数量,最小为1 最大99999 示例值：1
Deadline	是	Integer	到期时间,最小为1 示例值：1
RuleName	是	String	规则名称,大资产中心:asset_center 示例值：cwp
SourceType	否	Integer	订单类型, 1 试用 2 赠送 3 体验 4 SSL-证书赠送 5 cvm赠送示例值：1
RegionId	否	Integer	地域, 1 广州 9新加坡, 默认为 1. 非必要情况不要选9 示例值：1
ExtraParam	否	String	额外参数,json字符串,包含ResourceId 资源ID,LicenseType 授权类型示例值：{"ResourceId":"resource-01"}

3. 输出参数

参数名称	类型	描述
Resource	OrderResource	资源对象示例值：{ "Id":1, "ResourceId":"white_resource-01", "BeginTime":"2022-05-31 00:00:00", "EndTime":"2022-06-10 00:00:00", "LicenseType":1 }
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

创建试用订单

输入示例

POST / HTTP/1.1
Host: cwp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWhiteListOrder
<公共请求参数>

{
    "LicenseType": 1,
    "LicenseNum": 10,
    "Deadline": 10,
    "SourceType": 1,
    "RuleName": "asset_center"
}

输出示例

{
    "Response": {
        "RequestId": "d1245804-b922-4c3b-8499-f95dce26b33c",
        "Resource": {
            "Id": 1,
            "ResourceId": "white_2415**",
            "BeginTime": "2022-05-31 00:00:00",
            "EndTime": "2022-06-10 00:00:00",
            "LicenseType": 1
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
OperationDenied	操作被拒绝。
ResourceNotFound	资源不存在。

创建白名单订单

本页目录：