Queries the endpoints of an instance.
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 |
---|---|---|---|---|
rds:DescribeDBInstanceNetInfo | READ |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ClientToken | string | No | 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. | ETnLKlblzczshOTUbOC***** |
DBInstanceId | string | Yes | The ID of the instance. | rm-uf6wjk5***** |
Flag | integer | No | A reserved parameter. | None |
DBInstanceNetRWSplitType | string | No | The type of the endpoint. Valid values:
NoteBy default, the system returns both types of endpoints. | Normal |
GeneralGroupName | string | No | The name of the dedicated cluster to which the instance belongs. This parameter takes effect only when the instance runs MySQL on RDS Standard Edition and is created in a dedicated cluster. | rgc-2ze***** |
Response parameters
Examples
Sample success responses
JSON
format
{
"SecurityIPMode": "safety",
"RequestId": "777C4593-8053-427B-99E2-105593277CAB",
"InstanceNetworkType": "VPC",
"DBInstanceNetInfos": {
"DBInstanceNetInfo": [
{
"VSwitchId": "vsw-uf6adz52c2p*****",
"ConnectionStringType": "Normal",
"ConnectionString": "rm-uf6w*****.mysql.rds.aliyuncs.com",
"ExpiredTime": "1209534",
"Upgradeable": "Disabled",
"MaxDelayTime": "12",
"IPType": "Public",
"Port": "3306",
"BabelfishPort": "1433",
"VPCId": "vpc-uf6f7l4fg90*****",
"DistributionType": "Standard",
"IPAddress": "192.168.XX.XX",
"SecurityIPGroups": {
"securityIPGroup": [
{
"SecurityIPs": "127.0.XX.XX",
"SecurityIPGroupName": "Default"
}
]
},
"DBInstanceWeights": {
"DBInstanceWeight": [
{
"Availability": "Unavailable",
"Weight": "100",
"DBInstanceId": "rm-uf6wjk5*****",
"Role": "None\n",
"DBInstanceType": "Master"
}
]
}
}
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | TimeoutRetryLater | Timeout, retry later. | - |
400 | InvalidDBInstanceName.NotFound | DB instance name not found. | - |
400 | IllegalParameter | Illegal parameter | The values of some parameters are invalid. |
400 | Readins.NotFound | Readonly instance not found. | - |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||
---|---|---|---|---|---|---|---|---|
2021-12-28 | The error codes of the API operation change.,The response structure of the API operation changes. | |||||||
|