Data Management: ListProxies - Data Management (DMS)

セキュアアクセスプロキシ機能によって生成されたプロキシをクエリします。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dms:ListProxies

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Tid	integer	任意	テナントの ID です。テナント ID を照会するには、GetUserActiveTenant 操作を呼び出します。	3***

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマです。
RequestId	string	リクエストの ID です。	5812180E-555F-5F90-BE4F-280576F4****
Success	boolean	リクエストが成功したかどうかを示します。有効な値は以下のとおりです。 true：リクエストは成功しました。 false：リクエストは失敗しました。	true
ErrorMessage	string	エラーメッセージです。	User can not access to Tenant [123445]
ErrorCode	string	エラーコードです。	UnknownError
ProxyList	array<object>	セキュアアクセスプロキシ機能によって生成されたプロキシです。
	object	セキュアアクセスプロキシ機能によって生成されたプロキシです。
ProxyId	integer	セキュアアクセスプロキシの ID です。	4**
CreatorId	integer	セキュアアクセスプロキシ機能を有効化したユーザーの ID です。	12****
CreatorName	string	セキュアアクセスプロキシ機能を有効化したユーザーのニックネームです。	test_name
InstanceId	integer	インスタンスの ID です。	183****
PrivateEnable	boolean	内部エンドポイントが有効化されているかどうかを示します。デフォルト値は true です。	true
PrivateHost	string	内部エンドポイントです。	dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com
PublicEnable	boolean	パブリックエンドポイントが有効化されているかどうかを示します。有効な値は以下のとおりです。 true：パブリックエンドポイントは有効化されています。 false：パブリックエンドポイントは無効化されています。	false
PublicHost	string	パブリックエンドポイントです。パブリックエンドポイントの有効／無効に関わらず、この値は常に返されます。説明 PublicEnable パラメーターの値が true の場合、Alibaba Cloud DNS (DNS) で解決可能な有効なパブリックエンドポイントが返されます。 PublicEnable パラメーターの値が false の場合、DNS で解決できない無効なパブリックエンドポイントが返されます。	dphzmy-5j8oimjsz6ze****-pub.proxy.dms.aliyuncs.com
HttpsPort	integer	HTTPS クライアントがデータベースインスタンスに接続するために使用するポート番号です。	443
ProtocolType	string	データベースの種類です。例：MYSQL。	MYSQL
ProtocolPort	integer	データベースインスタンスに接続するために使用するポート番号です。	3306
RegionId	string	リージョンの ID です。	cn-hangzhou

例

成功レスポンス

JSONJSON

{
  "RequestId": "5812180E-555F-5F90-BE4F-280576F4****",
  "Success": true,
  "ErrorMessage": "User can not access to Tenant [123445]",
  "ErrorCode": "UnknownError",
  "ProxyList": [
    {
      "ProxyId": 0,
      "CreatorId": 0,
      "CreatorName": "test_name",
      "InstanceId": 0,
      "PrivateEnable": true,
      "PrivateHost": "dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com",
      "PublicEnable": false,
      "PublicHost": "dphzmy-5j8oimjsz6ze****-pub.proxy.dms.aliyuncs.com",
      "HttpsPort": 443,
      "ProtocolType": "MYSQL",
      "ProtocolPort": 3306,
      "RegionId": "cn-hangzhou"
    }
  ]
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。