Domain name for API request: tse.intl.tencentcloudapi.com.
Modify the node health status of the upstream instance for the cloud-native gateway
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: ModifyUpstreamNodeStatus. |
| 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 | Gateway instance ID |
| ServiceName | Yes | String | Service name |
| Host | Yes | String | Access IP address or domain name |
| Port | Yes | Integer | Access Port |
| Status | Yes | String | HEALTHY or UNHEALTHY |
| Parameter Name | Type | Description |
|---|---|---|
| Result | Boolean | Success status Note: This field may return null, indicating that no valid values can be obtained. |
| 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. |
Set the upstream node to health
POST / HTTP/1.1
Host: tse.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action:DescribeCloudNativeAPIGatewayUpstream
<Common request parameters>
{
"GatewayId": "gateway-dde03767",
"ServiceName": "service1",
"Host": "10.0.0.1",
"Port": "8080",
"Status": "HEALTHY"
}
{
"Response": {
"RequestId": "ffadafb6-545d-461c-ad8c-baa26c0f8955"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback