查詢通訊協定服務匯出目錄資訊。
介面說明
查詢通訊協定服務匯出目錄資訊。
使用前提
呼叫本介面前,需確保以下三層資源模型中的每個相依資源都已存在:
-
檔案系統(FileSystem):呼叫 DescribeFileSystems 取得 FileSystemId。
-
通訊協定服務(ProtocolService):呼叫 DescribeProtocolService 取得 ProtocolServiceId,或呼叫 CreateProtocolService 建立。
-
匯出目錄(ProtocolMountTarget):呼叫 CreateProtocolMountTarget 建立並取得 ExportId,或呼叫 DescribeProtocolMountTarget 查詢。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| NextToken |
string |
否 |
當請求的返回結果被截斷時,您可以使用 NextToken 再次發起請求,以取得從目前截斷位置之後的內容。 |
M18xMA== |
| MaxResults |
integer |
否 |
每次查詢結果的個數。 取值範圍:10~100。預設值:20。 |
20 |
| FileSystemId |
string |
是 |
檔案系統 ID。
|
cpfs-099394bd928c**** |
| ClientToken |
string |
否 |
保證請求冪等性,從您的用戶端產生一個參數值,確保不同請求間該參數值唯一。 ClientToken 僅支援 ASCII 字元,且不能超過 64 個字元。更多資訊,請參見如何保證冪等性。 說明
若使用者未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 識別碼。每次 API 請求的 RequestId 可能不一樣。 |
123e4567-e89b-12d3-a456-42665544**** |
| ProtocolServiceId |
string |
是 |
通訊協定服務 ID。必填參數。 取得方式:呼叫 DescribeProtocolService 介面查詢通訊協定服務清單,從返回值中取得 ProtocolServiceId。 |
ptc-197ed6a00f2b**** |
| ExportId |
string |
是 |
通訊協定服務匯出目錄 ID。必填參數。 取得方式:
|
exp-19abf5beab8d**** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
請求 ID。 |
6299428C-3861-435D-AE54-9B330A00**** |
| NextToken |
string |
當請求的返回結果被截斷時,您可以使用 NextToken 再次發起請求,以取得從目前截斷位置之後的內容。 |
M18xMA== |
| ProtocolMountTarget |
object |
通訊協定服務匯出目錄資訊。 |
|
| ExportId |
string |
匯出目錄 ID。 |
exp-19abf5beab8d**** |
| ProtocolMountTargetDomain |
string |
通訊協定服務匯出目錄的網域名稱。 |
cpfs-0229cb80bcc0****-x******.cn-*****.cpfs.aliyuncs.com |
| ProtocolType |
string |
檔案系統通訊協定類型。 包括:
|
NFS |
| VpcId |
string |
通訊協定服務匯出的專用網路 ID。 |
vpc-bp1h5mxoqfuo3xurf**** |
| VSwitchId |
string |
通訊協定服務匯出的交換器 ID。 |
vsw-8vb2qjnxs6hiobzve**** |
| VSwitchIds |
array |
通訊協定服務匯出的交換器 ID 清單。 |
|
|
string |
通訊協定服務匯出的交換器 ID。 |
vsw-bp1q3ro8erikjjrb2**** |
|
| FsetId |
string |
Fileset ID。 |
fset-299b4ca04de8**** |
| Path |
string |
查詢到的 CPFS 目錄路徑。 格式:
|
/ |
| AccessGroupName |
string |
權限群組名稱。 預設權限群組:DEFAULT_VPC_GROUP_NAME |
DEFAULT_VPC_GROUP_NAME |
| CreateTime |
string |
建立時間。 返回格式:yyyy-MM-dd HH:mm:ss |
2025-12-22 17:49:25 |
| Status |
string |
通訊協定服務匯出目錄的狀態。包括:
|
AVAILABLE |
| Description |
string |
通訊協定服務匯出的描述。 |
此通訊協定服務匯出的描述 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "6299428C-3861-435D-AE54-9B330A00****",
"NextToken": "M18xMA==",
"ProtocolMountTarget": {
"ExportId": "exp-19abf5beab8d****",
"ProtocolMountTargetDomain": "cpfs-0229cb80bcc0****-x******.cn-*****.cpfs.aliyuncs.com",
"ProtocolType": "NFS",
"VpcId": "vpc-bp1h5mxoqfuo3xurf****",
"VSwitchId": "vsw-8vb2qjnxs6hiobzve****",
"VSwitchIds": [
"vsw-bp1q3ro8erikjjrb2****"
],
"FsetId": "fset-299b4ca04de8****",
"Path": "/",
"AccessGroupName": "DEFAULT_VPC_GROUP_NAME",
"CreateTime": "2025-12-22 17:49:25",
"Status": "AVAILABLE",
"Description": "此协议服务导出的描述。"
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | MissingFileSystemId | FileSystemId is mandatory for this action. | 未指定 FileSystemId 參數。 |
| 400 | MissingExportId | ExportId is mandatory for this action. | 未指定 ExportId 參數。 |
| 404 | InvalidFileSystem.NotFound | The specified file system does not exist. | 指定的檔案系統不存在。 |
| 404 | Resource.NotFound | The specified resource does not exist. | 指定的資源不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。