TrafficRoute DNS Suite
TrafficRoute DNS Suite
TrafficRoute DNS Suite
Document
Product Billing
VolcanoEngine DNS
Getting Started
Activate VolcanoEngine DNS And Add a Domain
Route User Requests to a Website Server
Set up an Email Address
Route User Requests to CDN
User Guide
Configure DNS servers provided by DNS for a Domain
Domain Management
DNS Record Management
Load Balancing
Import or Export DNS Records
Batch Operation
Line Group Management
Access Log Management
Value-added Services
API reference
Record Set APIs
Line APIs
DNS Query Metrics APIs
IP-based Line APIs
SDK Reference
IP-based Line Management
Legal
VolcanoEngine GTM
Getting Started
User Guide
GTM Instance Management
Policy Management
Rule Management
Software-defined parsing for AnyMatch
Pool Management
Alarms and Notifications
Statistics and Analysis
Health Check
Route analysis
API Reference
GTM instance management
Policy Management
Health Check Management
Pool Management
Rule Management
Load Feedback Management
Best Practices
FAQs
VolcanoEngine PrivateZone
Product Overview
Getting Started
User Guide
Domain Management
Authoritative domain management for cloud products
Record Management
ECS Hostname Records Management
Import or Export DNS Records
Advanced DNS
Resolver
Forward DNS Requests to An External DNS Server
Forward DNS Requests From On-premise IDC/Third-party Cloud Services to Resolver
Access Log Management
DNS Query M.etrics
Best Practices
Use the DNS Cache Plugin to Improve Availability
API Reference
Domain APIs
DNS Record APIs
Record Set APIs
Cross-account VPC Association APIs
Resolver APIs
ECS Hostname Synchronization APIs
Cross-account resource sharing
SDK Reference
VolcanoEngine HTTPDNS
Getting Started
User Guide
Custom domain resolution
Software-defined parsing: AnyMatch
Access log management
Use the DoH protocol
API Reference
Account management APIs
Key management interface
Domain name management interface
Custom parsing management interface
Encrypted DNS management interface
Client development guide
Use the client SDK
Integrate SDKs
Android SDK
iOS SDK
API Reference
Android SDK
HttpDNS class
Method
iOS SDK
TTDnsResolver class
Attribute
Method
VolcanoEngine PublicDNS
Getting Started
Troubleshooting Guide
- Documentation
TrafficRoute DNS SuiteVolcanoEngine GTMAPI ReferencePolicy ManagementGetPolicy
Copy page
Download PDFPolicy Management
GetPolicy
Copy pageDownload PDFGetPolicy
Get policy information of a GTM instance.
Request
- Request method: POST
- Endpoint: https://gtm.volcengineapi.com/?Action=GetPolicy&Version=2023-01-01
Debugging
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
Request parameters
Parameters | Type | Required or optional | Example value | Description |
Action | String | Is | GetPolicy | Set the value to "GetPolicy". |
Version | String | Is | 2023-01-01 | API version, value: 2023-01-01. |
GtmId | String | Is | e93cb374-2b33-4202-842f-c066a4462c03 | |
PolicyType | String | Is | geo | Strategy types.
|
Response parameters
The following table lists only the response parameters specific to this interface. For more information, see Return structure.
Parameters | Type | Example value | Description |
RoutingMode | String | lb | Routing mode. The value of this parameter is:
|
AlarmOnly | Boolean | true | When the current pool set is unavailable, does GTM only trigger an alert notification without automatically switching to an available pool?
|
Targets | Object | None | Routing target of the intelligent routing policy. |
PerfMode | String | perf | Routing modes of intelligent routing policies.
|
Statistics | Object | None | Statistics of address statuses. |
SourceFlow | Object | None | This parameter has no practical significance. You can ignore this parameter. |
Request example
POST https://gtm.volcengineapi.com/?Action=GetPolicy&Version=2023-01-01&GtmId=e93cb374-2b33-4202-842f-c066a4462c03&PolicyType=perf
Response example
{
"ResponseMetadata": {
"RequestId": "202505271038359108E08EA1368E1084A1",
"Action": "GetPolicy",
"Version": "2023-01-01",
"Service": "GTM",
"Region": "cn-boe-1"
},
"Result": {
"RoutingMode": "geo-lb",
"AlarmOnly": false,
"Targets": null,
"PerfMode": "perf",
"Statistics": {
"InactiveAddr": 0,
"ActiveAddr": 10
},
"SourceFlow": [],
"LoadImbalanceFactor": 0,
"IgnoreAddrWeightPercent": 0,
"IgnoreWaterPercent": 0,
"NoticeWaterPercent": 0,
"RatioThreshold": 0,
"FluctuationThreshold": 0,
"AddrPriority": "",
"CapacitySharing": false,
"CrossIspPenalty": 0,
"RttFactor": 0,
"ProxyMode": "",
"Listeners": null,
"DefaultLineAddrNum": 0,
"RelayHandleTime": 0
}
}
Common error codes
The following table lists the error codes related to this interface and its business logic. For public error codes, see the Public error codes document.
Status code | error codes | Error message | Note |
504 | internal error | Internal error | Internal error |
Last updated: 2025.11.04 20:36:37
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
