All Products
Search

This Product

    Alibaba Cloud DNS:CreateCloudGtmInstanceConfig

    Document Center

    Alibaba Cloud DNS:CreateCloudGtmInstanceConfig

    Last Updated:Apr 21, 2025
    This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

    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:
      • For mandatory resource types, indicate with a prefix of * .
      • 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:CreateCloudGtmInstanceConfigupdate
    *GtmInstance
    acs:alidns::{#accountId}:gtminstance/{#instanceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    AcceptLanguagestringNo

    The language of the response. Valid values:

    • zh-CN: Chinese
    • en-US: English
    		en-US
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request. You can specify a custom value for this parameter, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

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

    The ID of the Global Traffic Manager (GTM) 3.0 instance. This ID uniquely identifies a GTM 3.0 instance.

    		gtm-cn-jmp3qnw**03
    ScheduleZoneModestringNo

    The configuration mode of the access domain name. Valid values:

    • sys_assign: system allocation. This mode is not supported.
    • custom: custom allocation. You must select a zone within the account to which the instance belongs and enter a hostname to generate an access domain name.
    		custom
    ScheduleZoneNamestringNo

    The name of the parent zone for the access domain name configured in GTM. In most cases, the value of this parameter is the name of a zone hosted by Alibaba Cloud DNS. This zone belongs to the account to which the GTM instance belongs. You can specify the name of a zone or subzone.

    		example.com
    ScheduleHostnamestringNo

    The hostname of the access domain name.

    		www
    ScheduleRrTypestringNo

    The type of the Domain Name System (DNS) record configured for the access domain name. Valid values:

    • A: IPv4 address
    • AAAA: IPv6 address
    • CNAME: domain name
    		A
    TtlintegerNo

    The global time to live (TTL) period. Unit: seconds. The global TTL period affects how long the DNS records that map the access domain name to the addresses in the address pools are cached in the local DNS servers of Internet service providers (ISPs). You can specify a custom value.

    		30
    RemarkstringNo

    The description of the access domain name.

    		test
    EnableStatusstringNo

    The enabling state of the access domain name. Valid values:

    • enable: The access domain name is enabled and the intelligent scheduling policy of the corresponding GTM instance takes effect.
    • disable: The access domain name is disabled and the intelligent scheduling policy of the corresponding GTM instance is unavailable.
    		enable

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		536E9CAD-DB30-4647-AC87-AA5CC38C5382
    Successboolean

    Indicates whether the request was successful. Valid values:

    • true
    • false
    		true
    ConfigIdboolean

    The configuration ID of the access domain name. Two configuration IDs exist when the access domain name is bound to the same GTM instance but an A record and an AAAA record are configured for the access domain name. The configuration ID uniquely identifies a configuration.

    		config-000**1

    Examples

    Sample success responses

    JSONformat

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

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    No change history