tencent cloud

APIs

ModifyNetworkBasicInfo

Mode fokus
Ukuran font
Terakhir diperbarui: 2026-05-08 14:46:21

1. API Description

Domain name for API request: tse.intl.tencentcloudapi.com.

This API is used to modify the basic information of a cloud native API gateway instance network, such as bandwidth and description, as well as specification upgrade. Only modification of client public network or private network information is supported.

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: ModifyNetworkBasicInfo.
Version Yes String Common Params. The value used for this API: 2020-12-07.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
GatewayId Yes String Cloud Native API gateway instance ID.
GroupId Yes String Group ID
NetworkType Yes String Network type:
-Enable public IP address
-Public IPv6 address
-Internal private network
Vip Yes String IP address
InternetMaxBandwidthOut No Integer Public network outbound traffic bandwidth, [1,2048]Mbps
Description No String Description of load balancing
SlaType No String Load balancing specification types support:
-Leave empty for shared type.
-clb.c2.medium: standard specification
-clb.c3.small: High-performance type 1 specification
-clb.c3.medium: High-performance type 2 specification
-clb.c4.small: Super high-performance specification 1
-clb.c4.medium: Super high-performance specification 2
-clb.c4.large: Super high-performance specification 3
-clb.c4.xlarge: Super high-performance 4 specification.

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 Modify Gateway Instance Network Basic Info

Modify the private network info of the Kong client

Input Example

POST / HTTP/1.1
Host: tse.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyNetworkBasicInfo
<Common request parameters>

{
    "GatewayId": "gatway-dde03767",
    "GroupId": "group-4se0czf7",
    "NetworkType": "Open",
    "Vip": "172.10.10.1",
    "InternetMaxBandwidthOut": 1,
"Description": "Public network ingress load balancing"
    "SlaType": "clb.c3.small"
}

Output Example

{
    "Response": {
        "RequestId": "ffadafb6-545d-461c-ad8c-baa26c0f8955"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

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
FailedOperation.FailedOperation Operation failed.
FailedOperation.InternalError Operation failed. Internal error.
InternalError Internal error.
InvalidParameterValue Parameter value error.
InvalidParameterValue.InvalidParameterValue Invalid parameter value.
InvalidParameterValue.UpdateError Invalid request parameter caused update failure.
MissingParameter.MissParameter Missing required parameters.
OperationDenied.OperationDenied Operation not allowed.
ResourceNotFound.Forbidden The resource does not exist. Operation is not allowed.
ResourceNotFound.InstanceNotFound The instance does not exist.
ResourceNotFound.ResourceNotFound The resource does not exist.
UnauthorizedOperation.UnauthorizedOperation Unauthorized operation.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan