AddHDMInstance - Database Autonomy Service - Alibaba Cloud Documentation Center

Adds a database instance to Database Autonomy Service (DAS).

Operation description

Before you call this operation, take note of the following items:

If you use an Alibaba Cloud SDK or a DAS SDK to call this operation, we recommend that you use the latest version of the SDK.
If you use an SDK to call DAS, you must set the region to cn-shanghai.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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:
- The required resource types are displayed in bold characters.
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
hdm:AddHDMInstance	create	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
__context	string	No	The reserved parameter.	None
InstanceArea	string	Yes	The type of the instance on which the database is deployed. Valid values: RDS: an Alibaba Cloud database instance. ECS: an Elastic Compute Service (ECS) instance on which a self-managed database is deployed. IDC: a self-managed database instance that is not deployed on Alibaba Cloud. Note IDC refers to your data center.	ECS
InstanceId	string	No	The instance ID.	rm-2ze1jdv45i7l6****
Ip	string	No	The endpoint that is used to access the instance over internal networks.	rm-2ze1jdv45i7l6****.mysql.rds.aliyuncs.com
Port	string	No	The port that is used to access the instance over internal networks.	3306
Engine	string	No	The database engine. Valid values: MySQL PostgreSQL SQLServer PolarDBMySQL PolarDBPostgreSQL Redis MongoDB PolarDBOracle PolarDBX	MySQL
Username	string	No	The username that is used to log on to the database.	test****
Password	string	No	The password for the username.	122****
InstanceAlias	string	No	The name of the instance.	yuecq--test****
NetworkType	string	No	The network type of the instance.	VPC
VpcId	string	No	The virtual private cloud (VPC) ID.	vpc-m5e666n89m2bx8jar****
Region	string	No	The ID of the region in which the instance resides.	cn-hangzhou
FlushAccount	string	No	The reserved parameter.	None

Response parameters

Parameter	Type	Description	Example
	object
Message	string	The returned message. Note If the request was successful, Successful is returned. If the request failed, an error message such as an error code is returned.	Successful
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Synchro	string	The reserved parameter.	None
Data	object	The detailed information, including the error codes and the number of entries that are returned.
VpcId	string	The VPC ID.	vpc-m5e666n89m2bx8jar****
Token	string	The client token that is used to ensure the idempotence of the request.	tokenID
Ip	string	The 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 number of the instance that you want to access.	3306
OwnerId	string	The ID of the instance owner.	325352345
Uuid	string	The unique identifier of the instance.	hdm_3063db6792965c080a4bcb6e6304****
Error	string	The error message returned if the request failed.	InvalidRequestURL
Code	integer	The HTTP status code returned.	200
Role	string	The role of the current API caller.	master
TenantId	string	The tenant ID.	L0EPfLS**=SCE00000***
Code	string	The HTTP status code returned.	200
Success	string	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Sample success responses

JSONformat

{
  "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
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

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

Change history

Change time	Summary of changes	Operation

No change history