Add a GTM Address via OpenAPI Explorer - Alibaba Cloud DNS

Creates an address using the specified parameters.

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:CreateCloudGtmAddress

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AcceptLanguage	string	No	The language of the response. Valid values: zh-CN: Chinese. en-US (default): English.	zh-CN
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Make sure that the token is unique for each request. The token can contain a maximum of 64 ASCII characters.	1ae05db4-10e7-11ef-b126-00163e24****
Name	string	Yes	The name of the address.	Address-1
Type	string	Yes	The type of the address. Valid values: IPv4 IPv6 domain	IPv4
Address	string	Yes	The IP address or domain name.	223.5.XX.XX
AttributeInfo	string	No	The attribution information of the address.	当前版本不支持传入此参数，请不要传入参数。
Remark	string	No	The remarks about the address.	test
EnableStatus	string	Yes	The status of the address. Valid values: enable: The address is enabled. disable: The address is disabled.	enable
AvailableMode	string	Yes	The switchover mode for the address when a health check is abnormal. Valid values: auto: The system automatically manages the address status based on health check results. If an address is unhealthy, DNS resolution for it stops. If the address becomes healthy, DNS resolution resumes. manual: You manually manage the address status. If you set an address to abnormal, DNS resolution for it stops. It does not resume even if the address becomes healthy. If you set an address to normal, DNS resolution for it resumes. If a healthy address becomes unhealthy, the system sends an alert but does not stop DNS resolution.	auto
ManualAvailableStatus	string	No	The availability status of the address when the health check-based switchover mode is set to manual. Valid values: available: The address is available. In this state, DNS resolution for the address is normal. If a health check is abnormal, the system only sends an alert and does not stop DNS resolution. unavailable: The address is unavailable. In this state, DNS resolution for the address is stopped. DNS resolution is not resumed even if a health check is normal.	available
HealthJudgement	string	Yes	The condition for determining the health of the address. This parameter is required if you specify HealthTasks. Valid values: any_ok: At least one health check is successful. p30_ok: At least 30% of health checks are successful. p50_ok: At least 50% of health checks are successful. p70_ok: At least 70% of health checks are successful. all_ok: All health checks are successful.	p50_ok
HealthTasks	array<object>	No	The health check tasks for the address.
	object	No	The health check template for the address.
Port	integer	No	The service port of the destination address for the health check. This parameter is not supported for health checks that use the ping protocol.	80
TemplateId	string	No	The ID of the health check template.	mtp-89518052425100****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	46973D4C-E3E4-4ABA-9190-9A9DE406C7E
Success	boolean	Indicates whether the address was created. Valid values: true: The operation was successful. false: The operation failed.	true
AddressId	string	The unique ID of the address.	addr-8951821811436****

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.