DescribeGtmAccessStrategyAvailableConfig

Updated at: 2024-10-24 08:16

Queries the configuration items that can be set for an access policy.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
OperationAccess levelResource typeCondition keyAssociated operation
alidns:DescribeGtmAccessStrategyAvailableConfigget
  • GtmInstance
    acs:alidns::{#accountId}:gtminstance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
LangstringNo

The language.

en
InstanceIdstringYes

The ID of the Global Traffic Manager (GTM) instance.

gtm-cn-xxxx

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

C2851BA9-CE56-49AF-8D12-4FC6A49EE688
AddrPoolsarray<object>

The address pools.

AddrPoolobject
AddrPoolIdstring

The ID of the address pool.

hra0ix
AddrPoolNamestring

The name of the address pool.

test
Linesarray<object>

The Domain Name System (DNS) request sources.

Lineobject
Statusstring

The state of the line. Valid values:

  • FORBIDDEN: The line is unavailable.
  • OPTIONAL: The line is available.
FORBIDDEN
FatherCodestring

The code of the parent line. No value is returned if no parent line exists.

telecom
LineCodestring

The code of the DNS request source.

cn_telecom_hubei
GroupNamestring

The group name of the DNS request source.

Mainland China
LineNamestring

The name of the DNS request source.

South China
GroupCodestring

The group number of the DNS request source.

ISP
SuggestSetDefaultLineboolean

Indicates whether the global line is recommended.

True

Examples

Sample success responses

JSONformat

{
  "RequestId": "C2851BA9-CE56-49AF-8D12-4FC6A49EE688",
  "AddrPools": {
    "AddrPool": [
      {
        "AddrPoolId": "hra0ix",
        "AddrPoolName": "test"
      }
    ]
  },
  "Lines": {
    "Line": [
      {
        "Status": "FORBIDDEN",
        "FatherCode": "telecom",
        "LineCode": "cn_telecom_hubei",
        "GroupName": "Mainland China",
        "LineName": "South China",
        "GroupCode": "ISP"
      }
    ]
  },
  "SuggestSetDefaultLine": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
Change timeSummary of changesOperation
2023-03-23The response structure of the API has changedView Change Details
  • On this page (1)
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
Feedback