フォルダのすべてのサブフォルダの情報をクエリします。
操作説明
この API 操作を呼び出して、フォルダの第 1 レベルのサブフォルダの情報のみを表示できます。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ParentFolderId |
string |
任意 |
親フォルダの ID。 このパラメーターを空のままにすると、Root フォルダの第 1 レベルのサブフォルダの情報がクエリされます。 |
r-b1**** |
| QueryKeyword |
string |
任意 |
フォルダ名などのクエリに使用されるキーワード。 あいまい一致がサポートされています。 |
rdFolder |
| PageNumber |
integer |
任意 |
返すページ番号。 ページは 1 から始まります。デフォルト値：1。 |
1 |
| PageSize |
integer |
任意 |
各ページで返すエントリ数。 有効な値：1～100。デフォルト値：10。 |
10 |
| Tag |
array<object> |
任意 |
タグ。このパラメーターはフィルター条件を指定します。 |
|
|
object |
任意 |
タグ。 |
||
| Key |
string |
任意 |
タグのキー。 |
k1 |
| Value |
string |
任意 |
タグの値。 |
v1 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
返される結果。 |
||
| Folders |
object |
||
| Folder |
array<object> |
フォルダ。 |
|
|
array<object> |
フォルダに関する情報。 |
||
| CreateTime |
string |
フォルダが作成された時間。 |
2015-01-23T12:33:18Z |
| FolderId |
string |
フォルダの ID。 |
rd-evic31**** |
| FolderName |
string |
フォルダの名前。 |
project-1 |
| Tags |
object |
||
| Tag |
array<object> |
フォルダに追加されたタグ。 |
|
|
object |
フォルダに追加されたタグ。 |
||
| Key |
string |
タグのキー。 |
k1 |
| Value |
string |
タグの値。 |
v1 |
| PageNumber |
integer |
返されたページのページ番号。 |
1 |
| PageSize |
integer |
ページごとに返されるエントリ数。 |
5 |
| RequestId |
string |
リクエストの ID。 |
7B8A4E7D-6CFF-471D-84DF-195A7A241ECB |
| TotalCount |
integer |
返されたエントリの合計数。 |
2 |
例
成功レスポンス
JSONJSON
{
"Folders": {
"Folder": [
{
"CreateTime": "2015-01-23T12:33:18Z",
"FolderId": "rd-evic31****",
"FolderName": "project-1",
"Tags": {
"Tag": [
{
"Key": "k1",
"Value": "v1"
}
]
}
}
]
},
"PageNumber": 1,
"PageSize": 5,
"RequestId": "7B8A4E7D-6CFF-471D-84DF-195A7A241ECB",
"TotalCount": 2
}エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidParameter.ParentFolderId | The ParentFolderId is invalid. | |
| 404 | EntityNotExists.ResourceDirectory | The resource directory for the account is not enabled. We recommend that you first enable the resource directory for the account. | |
| 404 | EntityNotExists.Folder | The resource directory folder does not exist. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。