Call the AddHDMInstance API to add a database instance - Database Autonomy Service - Alibaba Cloud - Database Autonomy Service

Calls the AddHDMInstance operation to connect a database instance to Database Autonomy Service (DAS).

Operation description

Before you begin:

Use the latest version of the Alibaba Cloud or DAS SDK.
When calling DAS by using the SDK, set the region to cn-shanghai.

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

hdm:AddHDMInstance

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
__context	string	No	The reserved parameter.	None
InstanceArea	string	Yes	The database product to which the instance belongs. Valid values: RDS: cloud instance. ECS: self-managed instance on ECS. IDC: self-managed instance not on a public cloud. Note IDC stands for Internet Data Center.	ECS
InstanceId	string	No	The instance ID.	rm-2ze1jdv45i7l6****
Ip	string	No	The internal endpoint of the instance to be connected.	rm-2ze1jdv45i7l6****.mysql.rds.aliyuncs.com
Port	string	No	The internal network connection port of the instance.	3306
Engine	string	No	The database engine. Valid values: MySQL PostgreSQL SQLServer PolarDBMySQL PolarDBPostgreSQL Redis MongoDB PolarDBOracle PolarDBX	MySQL
Username	string	No	The username.	test****
Password	string	No	The password of the username.	122****
InstanceAlias	string	No	The instance name.	yuecq--test****
NetworkType	string	No	The network type of the instance.	VPC
VpcId	string	No	VPC ID。	vpc-m5e666n89m2bx8jar****
Region	string	No	The region in which the instance resides.	cn-hangzhou
FlushAccount	string	No	The reserved parameter.	None

Response elements

Element	Type	Description	Example
	object
Message	string	The returned message. Note If the request is successful, Successful is returned. If the request fails, an error message is returned, such as an error code.	Successful
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Synchro	string	The reserved parameter.	None
Data	object	The details, including the total number of entries and error codes.
VpcId	string	VPC ID。	vpc-m5e666n89m2bx8jar****
Token	string	The client token, which is a custom unique random string.	tokenID
Ip	string	The IP endpoint of the instance.	rm-de21209****.mysql.rds.aliyuncs.com
CallerUid	string	The user ID of the caller.	31063db679****
InstanceId	string	The instance ID.	rm-2ze1jdv45i7l6****
Port	integer	The port of the target instance.	3306
OwnerId	string	The owner ID.	325352345
Uuid	string	The unique identifier of the instance.	hdm_3063db6792965c080a4bcb6e6304****
Error	string	The error message.	InvalidRequestURL
Code	integer	The status code.	200
Role	string	The role information.	master
TenantId	string	The tenant ID.	L0EPfLS**=SCE00000***
Code	string	The status code.	200
Success	string	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true

Examples

Success response

JSON format

{
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Synchro": "None",
  "Data": {
    "VpcId": "vpc-m5e666n89m2bx8jar****",
    "Token": "tokenID",
    "Ip": "rm-de21209****.mysql.rds.aliyuncs.com",
    "CallerUid": "31063db679****",
    "InstanceId": "rm-2ze1jdv45i7l6****",
    "Port": 3306,
    "OwnerId": "325352345",
    "Uuid": "hdm_3063db6792965c080a4bcb6e6304****",
    "Error": "InvalidRequestURL",
    "Code": 200,
    "Role": "master",
    "TenantId": "L0EPfLS****=SCE00000*****"
  },
  "Code": "200",
  "Success": "true"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The request parameters are invalid.	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.	You do not have the permission to perform this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.