Domain name for API request: tse.intl.tencentcloudapi.com.
Query the public network details of a cloud native API gateway instance
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: DescribePublicNetwork. |
| 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 | gateway group ID |
| NetworkId | Yes | String | Network ID. |
| Parameter Name | Type | Description |
|---|---|---|
| Result | DescribePublicNetworkResult | Retrieve the cloud native API gateway public network detailed information response result. |
| 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. |
Query public network details of a cloud native API gateway instance
POST / HTTP/1.1
Host: tse.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePublicNetwork
<Common request parameters>
{
"GatewayId": "gateway-dde03767",
"GroupId": "group-4se0czf7",
"NetworkId": "network-z31df1dz"
}
{
"Response": {
"RequestId": "534d0349-0663-4dfa-882e-172fe893608e",
"Result": {
"GatewayId": "gateway-dde03767",
"PublicNetwork": {
"ConsoleType": "Konga",
"NetType": "Open",
"Status": "Open",
"AccessControl": {
"Mode": "Whitelist",
"CidrWhiteList": [
"0.0.0.0"
],
"CidrBlackList": []
},
"VpcId": "",
"SubnetId": "",
"HttpUrl": "",
"HttpsUrl": "https://gateway-dde03767-konga.gz.apigw.tencentcs.com:1337/",
"AdminUser": "admin",
"AdminPassword": "husdqwe1zd3sjwSIx4@",
"Vip": "",
"InternetMaxBandwidthOut": 0,
"Description": "",
"SlaType": "",
"SlaName": "",
"MultiZoneFlag": false,
"MasterZoneId": "",
"SlaveZoneId": "",
"MasterZoneName": "",
"SlaveZoneName": "",
"NetworkId": ""
},
"GroupId": "group-4se0czf7"
}
}
}
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 |
|---|---|
| FailedOperation.FailedOperation | Operation failed. |
| FailedOperation.InternalError | Operation failed. Internal error. |
| InternalError.CreateError | Create an internal error. |
| InternalError.InternalError | Internal service error. |
| InternalError.QueryError | Query internal error. |
| InvalidParameterValue.BadRequestFormat | Request format incorrect. |
| InvalidParameterValue.GatewayId | Gateway ID invalid |
| InvalidParameterValue.InvalidParameterValue | Invalid parameter value. |
| LimitExceeded.LimitExceeded | The parameter exceeds the limit. |
| MissingParameter.MissParameter | Missing required parameters. |
| OperationDenied.OperationDenied | Operation not allowed. |
| ResourceNotFound.InstanceNotFound | The instance does not exist. |
| ResourceNotFound.ResourceNotFound | The resource does not exist. |
| UnauthorizedOperation.UnauthorizedOperation | Unauthorized operation. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários