查詢目錄列表。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vs:DescribeDirectories | get |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| GroupId | string | 是 | 目錄所屬空間 ID。 | 348*****174-cn-qingdao |
| ParentId | string | 否 | 按上級目錄 ID 查詢。 | 399*****774-cn-qingdao |
| SortBy | string | 否 | 按給定字段排序，默認按 ID 排序。 | ID |
| SortDirection | string | 否 | 排序方式，默認升序。取值：
| asc |
| PageSize | long | 否 | 分頁大小，默認為 20 | 20 |
| PageNum | long | 否 | 第幾個分頁，默認為 1 | 1 |
| NoPagination | boolean | 否 | 是否禁用分頁，默認 false | false |
返回參數
示例
正常返回示例
JSON格式
{
"PageNum": 1,
"PageSize": 20,
"RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
"TotalCount": 1,
"PageCount": 1,
"Directories": [
{
"ParentId": "399*****774-cn-qingdao",
"Description": "目錄2",
"GroupId": "348*****174-cn-qingdao",
"Name": "目錄2",
"CreatedTime": "2021-09-10T10:00:00Z",
"Id": "399*****488-cn-qingdao"
}
]
}JSON格式
{
"PageNum": 1,
"PageSize": 20,
"RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
"TotalCount": 1,
"PageCount": 1,
"Directories": [
{
"ParentId": "399*****774-cn-qingdao",
"Description": "目錄2",
"GroupId": "348*****174-cn-qingdao",
"Name": "目錄2",
"CreatedTime": "2021-09-10T10:00:00Z",
"Id": "399*****488-cn-qingdao"
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。