All Products
Search

This Product

    Alibaba Cloud DNS:CreateCloudGtmAddress

    Document Center

    Alibaba Cloud DNS:CreateCloudGtmAddress

    Last Updated:Apr 21, 2025

    Creates an address.

    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:CreateCloudGtmAddresscreate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    AcceptLanguagestringNo

    The language of the response. Valid values:

    • zh-CN: Chinese
    • en-US (default): English
    		zh-CN
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, 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
    NamestringYes

    Address name.

    		Address-1
    TypestringYes

    Address type:

    • IPv4
    • IPv6
    • domain
    		IPv4
    AddressstringYes

    IP address or domain name.

    		223.5.XX.XX
    AttributeInfostringNo

    Address ownership information.

    RemarkstringNo

    Remarks.

    		test
    EnableStatusstringYes

    Indicates the current enabled status of the address:

    • enable: Enabled status
    • disable: Disabled status
    		enable
    AvailableModestringYes

    The failover mode that is used when address exceptions are identified. Valid values:

    • auto: the automatic mode. The system determines whether to return an address based on the health check results. If the address fails health checks, the system does not return the address. If the address passes health checks, the system returns the address.
    • manual: the manual mode. If an address is in the unavailable state, the address is not returned for DNS requests even if the address passes health checks. If an address is in the available state, the address is returned for DNS requests even if an alert is triggered when the address fails health checks.
    		auto
    ManualAvailableStatusstringNo

    The availability state of the address. This parameter is required when AvailableMode is set to manual. Valid values:

    • available: The address is normal. In this state, the address is returned for DNS requests even if an alert is triggered when the address fails health checks.
    • unavailable: The address is abnormal. In this state, the address is not returned for DNS requests even if the address passes health checks.
    		available
    HealthJudgementstringYes

    The condition for determining the health status of the address. This parameter is required when HealthTasks is specified. Valid values:

    • any_ok: The health check results of at least one health check template are normal.
    • p30_ok: The health check results of at least 30% of health check templates are normal.
    • p50_ok: The health check results of at least 50% of health check templates are normal.
    • p70_ok: The health check results of at least 70% of health check templates are normal.
    • all_ok: The health check results of all health check templates are normal.
    		p50_ok
    HealthTasksarray<object>No

    The health check tasks associated with the address.

    HealthTaskobjectNo

    The health check template associated with the address.

    PortintegerNo

    The service port of the address on which health check tasks are performed. If the ping protocol is used for health checks, the configuration of the service port is not supported.

    		80
    TemplateIdstringNo

    The ID of the health check template associated with the address.

    		mtp-89518052425100**80

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    Unique request identification code.

    		46973D4C-E3E4-4ABA-9190-9A9DE406C7E
    Successboolean

    Indicates whether the address creation operation is successful:

    • true: Operation was successful
    • false: Operation was failed
    		true
    AddressIdstring

    The address ID. This ID uniquely identifies the address.

    		addr-8951821811436**192

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "46973D4C-E3E4-4ABA-9190-9A9DE406C7E",
  "Success": true,
  "AddressId": "addr-8951821811436**192"
}

    Error codes

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