All Products
Search

This Product

    Alibaba Cloud DNS:DescribeGtmInstance

    Document Center

    Alibaba Cloud DNS:DescribeGtmInstance

    Last Updated:Dec 02, 2025

    Queries the details of a Global Traffic Manager (GTM) instance.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    alidns:DescribeGtmInstance

    get

    *gtminstance

    acs:alidns::{#accountId}:gtminstance/{#instanceId}

    None

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    Lang

    string

    No

    The language.

    en

    InstanceId

    string

    Yes

    The ID of the GTM instance.

    instance1

    NeedDetailAttributes

    boolean

    No

    Specifies whether to return additional information. The default value is false. If you set this parameter to true, the response includes AccessStrategyNum (the number of access policies) and AddressPoolNum (the number of address pools).

    false

    Response elements

    Element

    Type

    Description

    Example

    object

    ExpireTimestamp

    integer

    The expiration time of the instance. This is a UNIX timestamp.

    1528284856000

    UserDomainName

    string

    The custom domain name.

    dns-example.top

    RequestId

    string

    The unique ID of the request.

    E41AA251-F9BA-48C6-99B2-2B82B26A573A

    LbaStrategy

    string

    The load balancing policy.

    • ALL_RR: round-robin

    • RATIO: weighted round-robin

    RATIO

    InstanceId

    string

    The ID of the GTM instance.

    gtm-cn-wwo3a3hbz**

    CreateTime

    string

    The time when the instance was created.

    2018-06-06T11:34Z

    CnameMode

    string

    The CNAME access mode. Valid values:

    • SYSTEM_ASSIGN: The system assigns a domain name.

    • CUSTOM: You use a custom domain name.

    CUSTOM

    Ttl

    integer

    The global TTL.

    60

    Cname

    string

    The CNAME access domain name.

    gtm-cn-wwo3a3hbz**.dns-example.top

    InstanceName

    string

    The name of the instance.

    test

    VersionCode

    string

    The version code.

    biaozhun

    AlertGroup

    string

    The alert contact group.

    [\"Testing for R&D team\"]

    AddressPoolNum

    integer

    The number of address pools.

    5

    AccessStrategyNum

    integer

    The number of access policies.

    5

    ExpireTime

    string

    The time when the instance expires.

    2018-06-06T11:34Z

    CreateTimestamp

    integer

    The time when the instance was created. This is a UNIX timestamp.

    1528284856000

    ResourceGroupId

    string

    The ID of the resource group.

    rg-testgroupid

    Examples

    Success response

    JSON format

    {
  "ExpireTimestamp": 1528284856000,
  "UserDomainName": "dns-example.top",
  "RequestId": "E41AA251-F9BA-48C6-99B2-2B82B26A573A",
  "LbaStrategy": "RATIO",
  "InstanceId": "gtm-cn-wwo3a3hbz**",
  "CreateTime": "2018-06-06T11:34Z",
  "CnameMode": "CUSTOM",
  "Ttl": 60,
  "Cname": "gtm-cn-wwo3a3hbz**.dns-example.top",
  "InstanceName": "test",
  "VersionCode": "biaozhun",
  "AlertGroup": "[\\\"日常测试-研发组\\\"]",
  "AddressPoolNum": 5,
  "AccessStrategyNum": 5,
  "ExpireTime": "2018-06-06T11:34Z",
  "CreateTimestamp": 1528284856000,
  "ResourceGroupId": "rg-testgroupid"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.