You can call this operation to query the available configurations of the current access policy of a Global Traffic Manager (GTM) policy.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeGtmAccessStrategyAvailableConfig

The operation that you want to perform. Set the value to DescribeGtmAccessStrategyAvailableConfig.

InstanceId String Yes gtm-cn-xxxx

The ID of the GTM instance for which you want to query the available configurations of the current access policy.

Lang String No en

The language used by the user.

Response parameters

Parameter Type Example Description
AddrPools Array

The returned list of address pools.

AddrPool

The details about an address pool.

AddrPoolId String hra0ix

The ID of the address pool.

AddrPoolName String Alibaba Cloud cluster

The name of the address pool.

Lines Array

The returned lines of access regions.

Line

The details about the line of an access region.

FatherCode String telecom

The code of the parent line for the access region. If no parent line exists, leave this parameter blank.

GroupCode String ISP

The code of the access region group.

GroupName String Operator

The name of the access region group.

LineCode String cn_telecom_hubei

The code for the line of the access region.

LineName String Hubei Telecom

The name for the line of the access region.

Status String FORBIDDEN

The current status of the line. Valid values:

  • FORBIDDEN: Unavailable
  • OPTIONAL: Availabe
RequestId String C2851BA9-CE56-49AF-8D12-4FC6A49EE688

The ID of the request.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribeGtmAccessStrategyAvailableConfig
&InstanceId=gtm-cn-xxxx
&<Common request parameters>

Sample success responses

XML format

<DescribeGtmAccessStrategyAvailableConfigResponse>
  <Lines>
		    <Line>
			      <Status>FORBIDDEN</Status>
			      <GroupName>Global</GroupName>
			      <GroupCode>DEFAULT</GroupCode>
			      <LineName>Global</LineName>
			      <LineCode>default</LineCode>
		    </Line>
		    <Line>
			      <Status>OPTIONAL</Status>
			      <GroupName>Carrier<GroupName>
			      <GroupCode>ISP</GroupCode>
			      <LineName>China Telecom</LineName>
			      <LineCode>telecom</LineCode>
		    </Line>
		    <Line>
			      <Status>OPTIONAL</Status>
			      <GroupName>Outside China</GroupName>
			      <GroupCode>OS</GroupCode>
			      <LineName>South America</LineName>
			      <LineCode>os_samerica</LineCode>
		    </Line>
	  </Lines>
	  <RequestId>C2851BA9-CE56-49AF-8D12-4FC6A49EE688</RequestId>
	  <AddrPools>
		    <AddrPool>
			      <AddrPoolName>Address pool 1 </AddrPoolName>
			      <AddrPoolId>hra0ix</AddrPoolId>
		    </AddrPool>
		    <AddrPool>
			      <AddrPoolName>Address pool 2</AddrPoolName>
			      <AddrPoolId>hra0iy</AddrPoolId>
		    </AddrPool>
	  </AddrPools>
</DescribeGtmAccessStrategyAvailableConfigResponse>

JSON format

{
	"Lines":{
		"Line":[
			{
				"Status":"FORBIDDEN",
				"GroupCode":"DEFAULT",
				"GroupName":"global",
				"LineName":"global",
				"LineCode":"default"
			},
			{
				"Status":"OPTIONAL",
				"GroupCode":"ISP",
				"GroupName":"ISP",
				"LineName":"China Telecom",
				"LineCode":"telecom"
			},
			{
				"Status":"OPTIONAL",
				"GroupCode":"OS",
				"GroupName":"outside of China",
				"LineName":"South America",
				"LineCode":"os_samerica"
			}
		]
	},
	"RequestId":"C2851BA9-CE56-49AF-8D12-4FC6A49EE688",
	"AddrPools":{
		"AddrPool":[
			{
				"AddrPoolName":"Address pool 1",
				"AddrPoolId":"hra0ix"
			},
			{
				"AddrPoolName":"Address pool 2",
				"AddrPoolId":"hra0iy"
			}
		]
	}
}

Error codes

For a list of error codes, visit the API Error Center.