TestInstanceConnection - - Alibaba Cloud Dokümantasyon Merkezi

Bir örneğe bağlantıyı test eder.

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

dms:TestInstanceConnection

none

*All resources.

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceResourceId	string	No	Alibaba Cloud veritabanı örneğinin kimliği.	rm-bp1p****
DbType	string	No	Veritabanı türü. Geçerli değerler için DbType parametre açıklaması bölümüne bakın.	polardb
Region	string	No	Örneğin bölge kimliği.	cn-hangzhou
Account	string	No	Hesabın adı.	1878076129455271
Password	string	No	Veritabanı parolası.	******
Id	string	No	Örneğin kimliği.	24***
InstanceSource	string	No	Örneğin kaynağı.	RDS
Host	string	No	Örneğin bağlantı uç noktası.	xxx.mysql.rds.aliyuncs.com
Port	string	No	Veritabanının bağlantı noktası.	3306

Response elements

Element	Type	Description	Example
	object
ErrorCode	string	İstek sırasında bir istisna oluşursa döndürülen hata kodu.	UnknownError
ErrorMessage	string	Çağrı başarısız olursa döndürülen hata mesajı.	Specified parameter PageSize is not valid.
PingResult	object	Döndürülen sonuç.
ErrorType	string	Hata türü.	ACCESS_DENIED
Message	string	Çalıştırma başarısız olursa döndürülen hata mesajı.	successful!
Success	boolean	İsteğin başarılı olup olmadığını gösterir. Geçerli değerler: true: İstek başarılıdır. false: İstek başarısız olur.	True
Title	string	Başlık.	Access denied
RequestId	string	İstek kimliği.	31853A2B-DC9D-5B39-8492-D2AC8BCF550E
Success	boolean	İsteğin başarılı olup olmadığını gösterir.	true

Examples

Success response

JSON format

{
  "ErrorCode": "UnknownError",
  "ErrorMessage": "Specified parameter PageSize is not valid.",
  "PingResult": {
    "ErrorType": "ACCESS_DENIED",
    "Message": "successful!",
    "Success": true,
    "Title": "Access denied"
  },
  "RequestId": "31853A2B-DC9D-5B39-8492-D2AC8BCF550E",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.