全部產品
Search
文件中心

Data Management:GetProxy - 擷取資料安全訪問代理的詳細資料

更新時間:Mar 21, 2026

擷取資料安全訪問代理的詳細資料。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:GetProxy

get

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

ProxyId

integer

安全訪問代理 ID,可通過調用介面 ListProxies 擷取該參數。

4**

Tid

integer

租戶 ID,可通過調用介面 GetUserActiveTenant 擷取該參數的值。

3***

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

請求 ID。

F49D4598-2B3C-5723-865E-2CCB818E****

Success

boolean

請求是否成功,傳回值如下:

  • true:請求成功

  • false:請求失敗

true

ErrorMessage

string

錯誤資訊。

The condition cannot be empty!

ErrorCode

string

錯誤碼。

UnknownError

ProxyId

integer

安全訪問代理 ID。

4**

CreatorId

integer

安全訪問代理建立人的使用者識別碼。

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:禁用

true

PublicHost

string

公網地址,公網地址始終都會返回。

說明
  • 當公網地址的開啟狀態為 true 時,此處返回的公網地址為有 DNS 解析能力的有效地址。

  • 當公網地址的開啟狀態為 false 時,此處返回的公網地址為無 DNS 解析能力的無效地址。

dphzmy-5j8oimjsz6zed7k****.proxy.dms.aliyuncs.com

HttpsPort

integer

HTTPS 協議連接埠號碼。

443

ProtocolType

string

資料庫協議類型,例如:MYSQL

MYSQL

ProtocolPort

integer

資料庫協議串連連接埠號碼

3306

RegionId

string

執行個體地區

cn-hangzhou

樣本

正常返回樣本

JSON格式

{
  "RequestId": "F49D4598-2B3C-5723-865E-2CCB818E****",
  "Success": true,
  "ErrorMessage": "The condition cannot be empty!",
  "ErrorCode": "UnknownError",
  "ProxyId": 0,
  "CreatorId": 0,
  "CreatorName": "test_name",
  "InstanceId": 0,
  "PrivateEnable": true,
  "PrivateHost": "dphzmy-5j8oimjsz6ze****.proxy.dms.aliyuncs.com",
  "PublicEnable": true,
  "PublicHost": "dphzmy-5j8oimjsz6zed7k****.proxy.dms.aliyuncs.com",
  "HttpsPort": 443,
  "ProtocolType": "MYSQL",
  "ProtocolPort": 3306,
  "RegionId": "cn-hangzhou"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情