You can call this operation to query the details about an access policy of a Global Traffic Manager (GTM) instance based on the policy ID.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeGtmAccessStrategy |
The operation that you want to perform. Set the value to DescribeGtmAccessStrategy. |
StrategyId | String | Yes | hra0hs |
The ID of the access policy that you want to query. |
Lang | String | No | en |
The language used by the user. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
AccessMode | String | AUTO |
The access policy. |
AccessStatus | String | DEFAULT |
The access status. Valid values:
|
DefaultAddrPoolMonitorStatus | String | OPEN |
Indicates whether health check is enabled for the default address pool. |
DefaultAddrPoolName | String | Address pool 1 |
The name of the default address pool. |
DefaultAddrPoolStatus | String | AVAILABLE |
The availability status of the default address pool. |
DefultAddrPoolId | String | hra0i1 |
The ID of the default address pool. |
FailoverAddrPoolId | String | hra0i2 |
The ID of the failover address pool. |
FailoverAddrPoolMonitorStatus | String | OPEN |
Indicates whether health check is 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 policy details 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. |
RequestId | String | BA1608CA-834C-4E63-8682-8AF0B11ED72D |
The ID of the request. |
StrategyId | String | hra0hs |
The ID of the access policy queried. |
StrategyMode | String | SELF_DEFINED |
The mode of traffic scheduling. |
StrategyName | String | Access policy |
The name of the access policy queried. |
Examples
Sample requests
http(s)://avds.aliyuncs.com/? Action=DescribeGtmAccessStrategy
&StrategyId=hra0hs
&<Common request parameters>
Sample success responses
XML
format
<DescribeGtmAccessStrategyResponse>
<StrategyName>access policy test</StrategyName>
<AccessMode>DEFAULT</AccessMode>
<Lines>
<Line>
<GroupName>Global</GroupName>
<GroupCode>DEFAULT</GroupCode>
<LineName>Global</LineName>
<LineCode>default</LineCode>
</Line>
<Line>
<GroupCode>ISP</GroupCode>
<GroupName>ISP</GroupName>
<LineCode>mobile</LineCode>
<LineName>China Mobile</LineName>
</Line>
</Lines>
<RequestId>BA1608CA-834C-4E63-8682-8AF0B11ED72D</RequestId>
<AccessStatus>DEFAULT</AccessStatus>
<CreateTime>2018-08-09T00:10Z</CreateTime>
<CreateTimestamp>1533773400000</CreateTimestamp>
<DefaultAddrPoolId>hra0i1</DefaultAddrPoolId>
<DefaultAddrPoolName>Address pool 1</DefaultAddrPoolName>
<FailoverAddrPoolId>hra0i2</FailoverAddrPoolId>
<FailoverAddrPoolName>Address pool 2</FailoverAddrPoolName>
<InstanceId>instance1</InstanceId>
<StrategyMode>SELF_DEFINED</StrategyMode>
<StrategyId>hra0hs</StrategyId>
<FailoverAddrPoolStatus>AVAILABLE</FailoverAddrPoolStatus>
<FailoverAddrPoolMonitorStatus>OPEN</FailoverAddrPoolMonitorStatus>
<DefaultAddrPoolStatus>AVAILABLE</DefaultAddrPoolStatus>
<DefaultAddrPoolMonitorStatus>CLOSE</DefaultAddrPoolMonitorStatus>
</DescribeGtmAccessStrategyResponse>
JSON
format
{
"FailoverAddrPoolName":"address pool 2",
"CreateTimestamp":1533773400000,
"Lines":{
"Line":[
{
"GroupCode":"DEFAULT",
"GroupName":"Global",
"LineName":"Global",
"LineCode":"default"
},
{
"GroupName":"ISP",
"GroupCode":"ISP",
"LineName":"China Mobile",
"LineCode":"mobile"
}
]
},
"DefaultAddrPoolId":"hra0i1",
"StrategyMode":"SELF_DEFINED",
"InstanceId":"instance1",
"DefaultAddrPoolStatus":"AVAILABLE",
"DefaultAddrPoolName":"address pool 1",
"DefaultAddrPoolMonitorStatus":"CLOSE",
"StrategyId":"hra0hs",
"FailoverAddrPoolStatus":"AVAILABLE",
"StrategyName":"Access policy test",
"AccessMode":"DEFAULT",
"RequestId":"BA1608CA-834C-4E63-8682-8AF0B11ED72D",
"CreateTime":"2018-08-09T00:10Z",
"FailoverAddrPoolId":"hra0i2",
"FailoverAddrPoolMonitorStatus":"OPEN",
"AccessStatus":"DEFAULT"
}
Error codes
For a list of error codes, visit the API Error Center.