All Products
Search

This Product

    Alibaba Cloud DNS:CreateCloudGtmInstanceConfig

    Document Center

    Alibaba Cloud DNS:CreateCloudGtmInstanceConfig

    Last Updated:Dec 02, 2025

    Creates a configuration for 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:CreateCloudGtmInstanceConfig

    create

    *GtmInstance

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    AcceptLanguage

    string

    No

    The language of the response. Valid values:

    • zh-CN: Chinese.

    • en-US: English.

    en-US
    ClientToken

    string

    No

    The client token that is used to ensure the idempotence of the request. You can specify a custom value, but you must make sure that the value is unique among different requests. The token can contain up to 64 ASCII characters.

    1ae05db4-10e7-11ef-b126-00163e24**22
    InstanceId

    string

    No

    The unique ID of the GTM 3.0 instance.

    gtm-cn-jmp3qnw**03
    ScheduleZoneMode

    string

    No

    The configuration mode for the access domain name:

    • sys_assign: The system assigns a domain name. This mode is no longer supported.

    • custom: Custom mode. Select a domain name under the account that owns the instance and enter a host record to generate the access domain name.

    custom
    ScheduleZoneName

    string

    No

    The zone name, which is the parent zone of the GTM access domain name. This is typically a domain name hosted in the Alibaba Cloud DNS console under the account that owns the GTM instance. Primary domains and subdomains are supported.

    example.com
    ScheduleHostname

    string

    No

    The host record of the GTM access domain name.

    www
    ScheduleRrType

    string

    No

    The DNS record type of the access domain name:

    • A: IPv4 address

    • AAAA: IPv6 address

    • CNAME: Canonical name

    A
    Ttl

    integer

    No

    The global Time to Live (TTL) in seconds. This is the TTL for the access domain name that resolves to an address in an address pool. This value affects how long the DNS record is cached on a carrier's local DNS server. You can specify a custom TTL.

    30
    Remark

    string

    No

    The remark.

    test
    EnableStatus

    string

    No

    The status of the domain name instance:

    • enable: Enabled. The intelligent scheduling policy of the GTM instance is active.

    • disable: Disabled. The intelligent scheduling policy of the GTM instance is unavailable.

    enable
    ChargeType

    string

    No

    The billing method for the instance configuration:

    • prepay: Subscription. This is the default value.

    • postpay: Pay-as-you-go.

    postpay

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The unique request ID.

    536E9CAD-DB30-4647-AC87-AA5CC38C5382
    Success

    boolean

    Indicates whether the operation was successful:

    • true: The operation was successful.

    • false: The operation failed.

    true
    ConfigId

    boolean

    The ID of the domain name instance configuration. A GTM instance can have both an A record and an AAAA record for the same access domain name. In this case, the GTM instance has two domain name instance configurations. The ConfigId uniquely identifies each configuration.

    config-000**1
    InstanceId

    string

    The ID of the instance.

    gtm-cn-xxxxx

    Examples

    Success response

    JSON format

    {
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "Success": true,
  "ConfigId": true,
  "InstanceId": "gtm-cn-xxxxx"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.