DescribeDBInstanceEndpoints - ApsaraDB RDS - Alibaba Cloud Documentation Center

Mengkueri informasi titik akhir instans seri kluster RDS.

Deskripsi operasi

Engine yang Didukung

RDS MySQL

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

rds:DescribeDBInstanceEndpoints

get

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

rds:ResourceTag

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Nilai dihasilkan oleh klien dan harus unik di antara permintaan yang berbeda. Nilai hanya dapat berisi karakter ASCII dan tidak boleh melebihi 64 karakter. Karakter non-ASCII tidak diizinkan.	ETnLKlblzczshOTUbOC****
DBInstanceId	string	Yes	ID instans. Anda dapat memanggil operasi DescribeDBInstances untuk mengkueri ID tersebut.	rm-u****
DBInstanceEndpointId	string	No	ID titik akhir instans. Catatan Jika Anda tidak menentukan parameter ini, informasi semua titik akhir akan dikembalikan.	ep-****-ro

Elemen respons

Element	Type	Description	Example
	object	Detail parameter tanggapan.
Data	object	Data yang dikembalikan.
DBInstanceEndpoints	object
DBInstanceEndpoint	array<object>	The information of the endpoints of the instance.
	array<object>	The details of the endpoint.
AddressItems	object
AddressItem	array<object>	The information about the endpoint.
	object	The connection details.
ConnectionString	string	The endpoints of the instance.	rm****.mysql.rds.aliyuncs.com
IpAddress	string	The IP address.	10.71.XX.XX
IpType	string	The type of the IP address. Valid values: Public: Internet Private: internal network	Private
Port	string	The port number of the endpoint.	3306
VSwitchId	string	The vSwitch ID.	vsw-bp12u14ecz****
VpcId	string	The VPC ID.	vpc-bp17xdic25d****
EndpointDescription	string	The user-defined description of the endpoint.	for readonly business
EndpointId	string	The endpoint ID of the instance.	ep-****
EndpointType	string	The type of the endpoint. Valid values: Primary: the read/write endpoint of the instance Readonly: the read-only endpoint of the instance	Readonly
NodeItems	object
NodeItem	array<object>	The information about the node that is configured for the endpoint.
	object	The details of the endpoint.
DBInstanceId	string	The instance ID.	rm-u****
NodeId	string	The node ID.	rn-****13p6tum4289h
Weight	integer	The weight of the node. Read requests are distributed based on the weight. Valid values: 0 to 100.	50
DBInstanceName	string	Nama instans.	rm-u****
IpVersion	string	Versi protokol alamat IP. Nilai valid: ipv4 ipv6.	ipv4
RequestId	string	ID permintaan.	777C4593-8053-427B-****105593277CAB

Contoh

Respons sukses

JSONformat

{
  "Data": {
    "DBInstanceEndpoints": {
      "DBInstanceEndpoint": [
        {
          "AddressItems": {
            "AddressItem": [
              {
                "ConnectionString": "rm****.mysql.rds.aliyuncs.com",
                "IpAddress": "10.71.XX.XX",
                "IpType": "Private",
                "Port": "3306",
                "VSwitchId": "vsw-bp12u14ecz****",
                "VpcId": "vpc-bp17xdic25d****"
              }
            ]
          },
          "EndpointDescription": "for readonly business",
          "EndpointId": "ep-****",
          "EndpointType": "Readonly",
          "NodeItems": {
            "NodeItem": [
              {
                "DBInstanceId": "rm-u****",
                "NodeId": "rn-****13p6tum4289h",
                "Weight": 50
              }
            ]
          }
        }
      ]
    },
    "DBInstanceName": "rm-u****",
    "IpVersion": "ipv4"
  },
  "RequestId": "777C4593-8053-427B-****105593277CAB"
}

Kode kesalahan

HTTP status code	Error code	Error message
400	APICallingFailed	Meta db calling failed.
400	InvalidSourceCategory	specified source category is invalid.
400	InvalidDBInstanceConnType.Format	Specified DB instance conn type is not valid.
400	Forbidden	User not authorized to operate on the specified resource, or this API does not support RAM.
400	InvalidEngineVersion.NotSupport	The specified parameter "EngineVersion" is not valid.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400	KmsApiError	User secret key invalid.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.
500	ExternalFailure	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
404	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.
404	InvalidDBInstanceName.NotFound	The database instance does not exist.
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	Request.NotFound	The requested resource is not available.
404	HostInfo.NotFound	The specified host info is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.