产品动态
引擎更新动态
产品公告
Domain name for API request: cfw.intl.tencentcloudapi.com.
This API is used to create a firewall instance with domain name (The Region parameter is required).
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateNatFwInstanceWithDomain. |
| Version | Yes | String | Common Params. The value used for this API: 2019-09-04. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| Name | Yes | String | Firewall instance name |
| Width | Yes | Integer | Bandwidth |
| Mode | Yes | Integer | Mode. 1: use existing; 0: create new |
| NewModeItems | No | NewModeItems | Parameter passed for the Create New mode. Either NewModeItems or NatgwList is required. |
| NatGwList.N | No | Array of String | NAT gateway list for the Using Existing mode. Either NewModeItems or NatgwList is required. |
| Zone | No | String | Primary zone. The default zone is selected if it is empty. |
| ZoneBak | No | String | Secondary zone. The default zone is selected if it is empty. |
| CrossAZone | No | Integer | Remote disaster recovery. 1: enable; 0: disable; empty: disable by default |
| IsCreateDomain | No | Integer | 0: not create; 1: create |
| Domain | No | String | Required for creating a domain name |
| FwCidrInfo | No | FwCidrInfo | IP range of the firewall |
| Parameter Name | Type | Description |
|---|---|---|
| CfwInsId | String | NAT instance info Note: This field may return null, indicating that no valid value was found. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to apply the "Use existing" mode.
POST / HTTP/1.1
Host: cfw.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateNatFwInstanceWithDomain
<Common request parameters>
{
"Name": "test",
"Width": 20,
"Mode": 0,
"CrossAZone": 1,
"NatGwList": [
"nat-xxx",
"nat-xxx"
],
"Zone": "ap-shanghai-4",
"ZoneBak": "ap-shanghai-3"
}{
"Response": {
"CfwInsId": "xxx",
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}This example shows you how to apply the "Create New" mode.
POST / HTTP/1.1
Host: cfw.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateNatFwInstanceWithDomain
<Common request parameters>
{
"Name": "test",
"Width": 20,
"Mode": 1,
"CrossAZone": 1,
"NewModeItems": {
"VpcList": [
"vpc-xxx"
],
"Eips": [
"xx.xx.xx.xx"
],
"AddCount": 1
},
"Zone": "ap-shanghai-4",
"ZoneBak": "ap-shanghai-3"
}{
"Response": {
"CfwInsId": "xxx",
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| DryRunOperation | DryRun operation, which means the DryRun parameter is passed in yet the request will still be successful. |
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | Invalid parameter value. |
| LimitExceeded | The quota limit has been reached. |
| MissingParameter | Missing parameter. |
| OperationDenied | Operation denied. |
| RequestLimitExceeded | The number of requests exceeds the frequency limit. |
| ResourceInUse | The resource is occupied. |
| ResourceInsufficient | Insufficient resource. |
| ResourceNotFound | The resource does not exist. |
| ResourceUnavailable | The resource is unavailable. |
| ResourcesSoldOut | The resources have been sold out. |
| UnauthorizedOperation | Unauthorized operation. |
| UnknownParameter | Unknown parameter error. |
| UnsupportedOperation | Unsupported operation. |
文档反馈