You can call this operation to query the access policies of a Global Traffic Manager (GTM) instance.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeGtmAccessStrategies |
The operation that you want to perform. Set the value to DescribeGtmAccessStrategies. |
InstanceId | String | No | instance1 |
The ID of the GTM instance whose access policies you want to query. |
Lang | String | No | en |
The language used by the user. |
PageNumber | Integer | No | 1 |
The number of the page to return. |
PageSize | Integer | No | 20 |
The number of entries to return per page. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
PageNumber | Integer | 1 |
The number of the page returned. |
PageSize | Integer | 20 |
The number of entries returned per page. |
RequestId | String | 0CCC9971-CEC9-4132-824B-4AE611C07623 |
The ID of the request. |
Strategies | Array |
The returned list of access policies of the GTM instance. |
|
Strategy |
The details about an access policy. |
||
AccessMode | String | DEFAULT |
The access policy. Valid values:
|
AccessStatus | String | DEFAULT |
The access status. Valid values:
|
CreateTime | String | 2018-08-09T00:10Z |
The time when the access policy was created. |
CreateTimeStamp | Long | 1533773400000 |
A timestamp that indicates the time when the access policy was created. |
DefaultAddrPoolId | String | hra0i1 |
The ID of the default address pool. |
DefaultAddrPoolMonitorStatus | String | OPEN |
Indicates whether health check was enabled for the default address pool. Valid values:
|
DefaultAddrPoolName | String | Address pool 1 |
The name of the default address pool. |
DefaultAddrPoolStatus | String | AVAILABLE |
The availability status of the default address pool. Valid values:
|
FailoverAddrPoolId | String | hra0i2 |
The ID of the failover address pool. |
FailoverAddrPoolMonitorStatus | String | OPEN |
Indicates whether health check was enabled for the failover address pool. |
FailoverAddrPoolName | String | Address pool 2 |
The name of the failover address pool. |
FailoverAddrPoolStatus | String | AVAILABLE |
The availability status of the failover address pool. |
InstanceId | String | instance1 |
The ID of the GTM instance whose access policies you want to query. |
Lines | Array |
The returned lines of access regions. |
|
Line |
The details about the line of an access region. |
||
GroupCode | String | DEFAULT |
The code of the access region group. |
GroupName | String | Global |
The name of the access region group. |
LineCode | String | default |
The code for the line of the access region. |
LineName | String | Global |
The name for the line of the access region. |
StrategyId | String | hra0hs |
The ID of the access policy. |
StrategyMode | String | SELF_DEFINED |
The mode of the access policy. SELF_DEFINED indicates that the access policy is user-defined. |
StrategyName | String | Access policy |
The name of the access policy. |
TotalItems | Integer | 1 |
The total number of entries returned on all pages. |
TotalPages | Integer | 1 |
The total number of pages returned. |
Examples
Sample requests
http(s)://avds.aliyuncs.com/? Action=DescribeGtmAccessStrategies
&<Common request parameters>
Sample success responses
XML
format
<DescribeGtmAccessStrategiesResponse>
<PageNumber>1</PageNumber>
<PageSize>20</PageSize>
<RequestId>0CCC9971-CEC9-4132-824B-4AE611C07623</RequestId>
<TotalItems>1</TotalItems>
<TotalPages>1</TotalPages>
<Strategies>
<Strategy>
<FailoverAddrPoolName>Address pool 2</FailoverAddrPoolName>
<FailoverAddrPoolStatus>AVAILABLE</FailoverAddrPoolStatus>
<FailoverAddrPoolMonitorStatus>OPEN</FailoverAddrPoolMonitorStatus>
<StrategyName>Access policy test</StrategyName>
<AccessMode>DEFAULT</AccessMode>
<CreateTimestamp>1533773400000</CreateTimestamp>
<Lines>
<Line>
<GroupName>Global</GroupName>
<GroupCode>DEFAULT</GroupCode>
<LineName>Global</LineName>
<LineCode>default</LineCode>
</Line>
</Lines>
<StrategyMode>SELF_DEFINED</StrategyMode>
<DefaultAddrPoolId>hra0i1</DefaultAddrPoolId>
<CreateTime>2018-08-09T00:10Z</CreateTime>
<FailoverAddrPoolId>hra0i2</FailoverAddrPoolId>
<DefaultAddrPoolName>Address pool 1</DefaultAddrPoolName>
<DefaultAddrPoolStatus>AVAILABLE</DefaultAddrPoolStatus>
<DefaultAddrPoolMonitorStatus>CLOSE</DefaultAddrPoolMonitorStatus>
<AccessStatus>DEFAULT</AccessStatus>
<InstanceId>instance1</InstanceId>
<StrategyId>hra0hs</StrategyId>
</Strategy>
</Strategies>
</DescribeGtmAccessStrategiesResponse>
JSON
format
{
"PageNumber":1,
"PageSize":20,
"RequestId":"0CCC9971-CEC9-4132-824B-4AE611C07623",
"TotalItems":1,
"TotalPages":1,
"Strategies":[
"Strategy": {
{
"FailoverAddrPoolName":"Address pool 2",
"CreateTimestamp":1533773400000,
"Lines":{
"Line":[
{
"GroupCode":"DEFAULT",
"GroupName":"Global",
"LineName":"Global",
"LineCode":"default"
}
]
},
"StrategyMode":"SELF_DEFINED",
"DefaultAddrPoolId":"hra0i1",
"InstanceId":"instance1",
"DefaultAddrPoolStatus":"AVAILABLE",
"DefaultAddrPoolName":"Address pool 1",
"DefaultAddrPoolMonitorStatus":"CLOSE",
"StrategyId":"hra0hs",
"FailoverAddrPoolStatus":"AVAILABLE",
"StrategyName":"Access policy test",
"AccessMode":"DEFAULT",
"CreateTime":"2018-08-09T00:10Z",
"FailoverAddrPoolId":"hra0i2",
"FailoverAddrPoolMonitorStatus":"OPEN",
"AccessStatus":"DEFAULT"
}
]
}
}
Error codes
For a list of error codes, visit the API Error Center.