ModifySecurityIPGroup
1. API Description
Domain name for API request: teo.tencentcloudapi.com.
This API is used to modify a security IP group.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
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: ModifySecurityIPGroup. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
| Region | No | String | Common Params. This parameter is not required. |
| ZoneId | Yes | String | Site ID. |
| IPGroup | Yes | IPGroup | IP group configuration. |
| Mode | Yes | String | Operation type. Valid values: append: Add information of Content to IPGroup;remove: Delete information of Content from IPGroup;update: Replace all information of IPGroup and modify the IPGroup name. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Modifying a security IP group with the operation "append"
This example shows you how to modify a security IP group with the operation "append".
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySecurityIPGroup
<Common request parameters>
{
"IPGroup": {
"GroupId": 67,
"Name": "test3",
"Content": [
"1.3.1.1/16",
"6.6.6.6"
]
},
"Mode": "append",
"ZoneId": "zone-hduqwh"
}
Output Example
{
"Response": {
"RequestId": "728cb059-8595-44c7-b6c6-b4a539ae823f"
}
}
Example2 Modifying a security IP group with the operation "remove"
This example shows you how to modify a security IP group with the operation "remove".
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySecurityIPGroup
<Common request parameters>
{
"IPGroup": {
"GroupId": 67,
"Name": "test3",
"Content": [
"1.3.1.1/16",
"6.6.6.6"
]
},
"Mode": "remove",
"ZoneId": "zone-hduqwh"
}
Output Example
{
"Response": {
"RequestId": "5bdc699c-68df-4cb7-9d0a-1c174b0374ad"
}
}
Example3 Modifying a security IP group with the operation "update"
This example shows you how to modify a security IP group with the operation "update".
Input Example
POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySecurityIPGroup
<Common request parameters>
{
"IPGroup": {
"GroupId": 67,
"Name": "test3",
"Content": [
"1.2.1.1/24",
"3.3.3.3"
]
},
"Mode": "update",
"ZoneId": "zone-hduqwh"
}
Output Example
{
"Response": {
"RequestId": "sh1u8a90-xxxx-49cd-swui-27cb34daa779"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError.ProxyServer | An unknown error occurred in the backend server. |
| InvalidParameter.Security | Invalid parameter. |
| ResourceNotFound | The resource doesn’t exist. |
| UnauthorizedOperation.CamUnauthorized | CAM is not authorized. |
| UnauthorizedOperation.Unknown | An unknown error occurred in the backend server. |
- 1. API Description
- 2. Input Parameters
- 3. Output Parameters
- 4. Example
- Example1 Modifying a security IP group with the operation "append"
- Example2 Modifying a security IP group with the operation "remove"
- Example3 Modifying a security IP group with the operation "update"
- 5. Developer Resources
- SDK
- Command Line Interface
- 6. Error Code