All Products
Search

This Product

    Alibaba Cloud DNS:DescribeGtmInstance

    Document Center

    Alibaba Cloud DNS:DescribeGtmInstance

    Last Updated:Oct 24, 2024

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

    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
    alidns:DescribeGtmInstanceget
    • gtminstance
      acs:alidns::{#accountId}:gtminstance/{#instanceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    LangstringNo

    The language of the values of specific response parameters.

    		en
    InstanceIdstringYes

    The ID of the GTM instance.

    		instance1
    NeedDetailAttributesbooleanNo

    Specifies whether additional information is required. Default value: false. If the value is true, the AccessStrategyNum and AddressPoolNum parameters are returned.

    		false

    Response parameters

    ParameterTypeDescriptionExample
    object
    ExpireTimestamplong

    The timestamp that indicates the time when the GTM instance expires.

    		1528284856000
    UserDomainNamestring

    The domain name of the application.

    		www.example.com
    RequestIdstring

    The ID of the request.

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

    The load balancing policy. Valid values:

    • ALL_RR: round robin
    • RATIO: weighted round-robin
    		RATIO
    InstanceIdstring

    The ID of the GTM instance.

    		instance1
    CreateTimestring

    The time when the GTM instance was created.

    		2018-06-06T11:34Z
    CnameModestring

    Indicates whether the CNAME is a custom domain name or is assigned by the system. Valid values:

    • SYSTEM_ASSIGN
    • CUSTOM
    		SYSTEM_ASSIGN
    Ttlinteger

    The global time to live (TTL).

    		60
    Cnamestring

    The domain name of the GTM instance to which the service domain name is mapped by using a CNAME record.

    		instance1.14.com
    InstanceNamestring

    The name of the GTM instance.

    		test
    VersionCodestring

    The version code.

    		biaozhun
    AlertGroupstring

    The alert group of the GTM instance.

    		\[\\"Daily test - R\&D group\\"]
    AddressPoolNuminteger

    The number of address pools of the GTM instance.

    		5
    AccessStrategyNuminteger

    The number of access policies of the GTM instance.

    		5
    ExpireTimestring

    The time when the GTM instance expires.

    		2018-06-06T11:34Z
    CreateTimestamplong

    The timestamp that indicates the time when the GTM instance was created.

    		1528284856000
    ResourceGroupIdstring

    The ID of the resource group.

    		rg-testgroupid

    Examples

    Sample success responses

    JSONformat

    {
  "ExpireTimestamp": 1528284856000,
  "UserDomainName": "www.example.com",
  "RequestId": "E41AA251-F9BA-48C6-99B2-2B82B26A573A",
  "LbaStrategy": "RATIO",
  "InstanceId": "instance1",
  "CreateTime": "2018-06-06T11:34Z",
  "CnameMode": "SYSTEM_ASSIGN",
  "Ttl": 60,
  "Cname": "instance1.14.com",
  "InstanceName": "test",
  "VersionCode": "biaozhun",
  "AlertGroup": "\\[\\\\\"Daily test - R\\&D group\\\\\"]\n",
  "AddressPoolNum": 5,
  "AccessStrategyNum": 5,
  "ExpireTime": "2018-06-06T11:34Z",
  "CreateTimestamp": 1528284856000,
  "ResourceGroupId": "rg-testgroupid"
}

    Error codes

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