You need to enable JavaScript to run this app.
TrafficRoute DNS Suite

TrafficRoute DNS Suite

Copy page
Download PDF
GTM instance management
UpdateGtm
Copy page
Download PDF
UpdateGtm
Update a GTM instance.​
Request​
  • Request method: POST​
  • Request address: https://gtm.volcengineapi.com/?Action=UpdateGtm&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​
The following table lists only the request parameters unique to this interface and some common parameters. For more information, see Public parameters.​
​
Parameters​
Type​
Required or optional​
Example value​
Description​
Action​
String​
Is​
UpdateGtm​
Operation to be performed (value: UpdateGtm).​
Version​
String​
Is​
2023-01-01​
API version. Value: 2023-01-01.​
GtmId​
String​
Is​
2a8f91c4-aa07-4ae4-9ebc-68750d611822​
Uuid of the GTM instance You can obtain the GtmId through ListGtms API.​
PolicyType​
String​
No​
geo​
Policies that take effect in the GTM instance.​
  • Geo: Basic routing.​
  • perf: intelligent routing.​
Ttl​
Integer​
No​
60​
The cache expiration time of routing domain DNS records in a GTM instance.​
Remark​
String​
No​
Remark​
GTM instance remark UTF-8 format. The maximum length is 128 UTF-8 characters.​
AlarmId​
String​
No​
157284163494346​
ID of the alarm rule associated with the GTM instance.​
​
Response parameters​
This API does not have any unique response parameters. For more information, see Return structure.​
Request example​
​
POST https://gtm.volcengineapi.com/?Action=UpdateGtm&Version=2023-01-01​
​
{​
"GtmId":"2a8f91c4-aa07-4ae4-9ebc-68750d611822",​
"Remark": "test"​
}​
​
Response example​
​
{​
"ResponseMetadata": {​
"RequestId": "20230817180124A911D7D31AC9914A50DE",​
"Action": "UpdateGtm",​
"Version": "2023-01-01",​
"Service": "GTM",​
"Region": "cn-north-1"​
}​
}​
​
Common error codes​
The following table lists the error codes related to this interface and business logic. For public error codes, refer to the Public Error Codes document.​
​
Status code​
error codes​
Error message​
Note​
504​
504​
Internal error​
​
​
​
Last updated: 2025.11.04 20:36:38