アクセスポイント情報を照会します。
この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに NAS(2017-06-26) - ListAccessPoints への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。
操作説明
この機能は汎用 NAS NFS ファイルシステムのみでサポートされています。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
nas:DescribeAccessPoints |
list |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| FileSystemId |
string |
任意 |
ファイルシステム ID。 |
174494**** |
| AccessGroup |
string |
任意 |
権限グループ名。 ファイルシステムが汎用 NAS ファイルシステムの場合、このパラメーターは必須です。 デフォルト権限グループ: DEFAULT_VPC_GROUP_NAME(デフォルト VPC 権限グループ)。 |
DEFAULT_VPC_GROUP_NAME |
| MaxResults |
integer |
任意 |
各クエリの結果数。 有効な値: 10~100。デフォルト値: 10。 |
10 |
| Tag |
array<object> |
任意 |
アクセスポイントタグのリスト。 |
|
|
object |
任意 |
アクセスポイントタグのリスト。 |
||
| Key |
string |
任意 |
タグキー。 使用制限:
|
TestKey |
| Value |
string |
任意 |
タグ値。 使用制限:
|
TestValue |
| NextToken |
string |
任意 |
クエリトークン。前回の API 呼び出しで返された NextToken の値を設定します。 |
MTY4NzcxOTcwMjAzMDk2Nzc0MyM4MDM4**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID。 |
6299428C-3861-435D-AE54-9B330A00**** |
| AccessPoints |
array<object> |
アクセスポイント情報。 |
|
|
array<object> |
|||
| ARN |
string |
アクセスポイントの Amazon リソースネーム (ARN)。 |
acs:nas:cn-hangzhou:178321033379****:accesspoint/ap-ie15yd**** |
| AccessGroup |
string |
権限グループ名。 |
test |
| AccessPointId |
string |
アクセスポイント ID。 |
ap-ie15y***** |
| AccessPointName |
string |
アクセスポイント名。 |
test |
| CreateTime |
string |
アクセスポイントが作成された時間。 |
1709619668276167 |
| DomainName |
string |
アクセスポイントのドメイン名。 |
ap-ie15ydanoz.001014****-w****.cn-hangzhou.nas.aliyuncs.com |
| EnabledRam |
boolean |
RAM ポリシーが有効かどうかを示します。 |
false |
| FileSystemId |
string |
ファイルシステム ID。 |
31a8e4**** |
| ModifyTime |
string |
アクセスポイントが最後に変更された時間。 |
1709619668276167 |
| PosixUser |
object |
POSIX ユーザー。 |
|
| PosixGroupId |
integer |
POSIX ユーザーグループの ID。 |
12 |
| PosixUserId |
integer |
POSIX ユーザーの ID。 |
123 |
| PosixSecondaryGroupIds |
array |
セカンダリユーザーグループの ID。 |
|
|
integer |
セカンダリユーザーグループの ID。 |
[123,123] |
|
| RootPath |
string |
ルートディレクトリ。 |
/ |
| RootPathPermission |
object |
ルートディレクトリの権限。 |
|
| OwnerGroupId |
integer |
所有者グループの ID。 |
12 |
| OwnerUserId |
integer |
所有者 ID。 |
1 |
| Permission |
string |
POSIX 権限。 |
0755 |
| RootPathStatus |
string |
現在のルートディレクトリのステータス。 有効な値:
|
2 |
| Status |
string |
現在のアクセスポイントのステータス。 有効な値:
説明
ファイルシステムをマウントできるのは、ステータスが Active の場合のみです。 |
Active |
| VSwitchId |
string |
vSwitch ID。 |
vsw-2zevmwkwyztjuoffg**** |
| VpcId |
string |
VPC ID。 |
vpc-2zesj9afh3y518k9o**** |
| Tags |
array<object> |
アクセスポイントタグのリスト。 |
|
|
object |
アクセスポイントタグのリスト。 |
||
| Key |
string |
リソースに追加されるタグのキー。 |
TestKey |
| Value |
string |
タグの値 |
TestValue |
| NextToken |
string |
クエリトークン。前回の API 呼び出しで返された NextToken の値を設定します。 |
MTY4NzcxOTcwMjAzMDk2Nzc0MyM4MDM4**** |
| TotalCount |
integer |
アクセスポイントの総数。 |
20 |
例
成功レスポンス
JSONJSON
{
"RequestId": "6299428C-3861-435D-AE54-9B330A00****",
"AccessPoints": [
{
"ARN": "acs:nas:cn-hangzhou:178321033379****:accesspoint/ap-ie15yd****",
"AccessGroup": "test",
"AccessPointId": "ap-ie15y*****\n",
"AccessPointName": "test",
"CreateTime": "1709619668276167",
"DomainName": "ap-ie15ydanoz.001014****-w****.cn-hangzhou.nas.aliyuncs.com",
"EnabledRam": false,
"FileSystemId": "31a8e4****\n",
"ModifyTime": "1709619668276167",
"PosixUser": {
"PosixGroupId": 12,
"PosixUserId": 123,
"PosixSecondaryGroupIds": [
0
]
},
"RootPath": "/",
"RootPathPermission": {
"OwnerGroupId": 12,
"OwnerUserId": 1,
"Permission": "0755"
},
"RootPathStatus": "2",
"Status": "Active",
"VSwitchId": "vsw-2zevmwkwyztjuoffg****\n",
"VpcId": "vpc-2zesj9afh3y518k9o****\n",
"Tags": [
{
"Key": "TestKey",
"Value": "TestValue"
}
]
}
],
"NextToken": "MTY4NzcxOTcwMjAzMDk2Nzc0MyM4MDM4****\n",
"TotalCount": 20
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidFilesystemType.NotSupport | The API operation does not support the file system type. | |
| 403 | InvalidProtocolType.NotSupported | The specified protocol type does not supported. | |
| 404 | InvalidFileSystem.NotFound | The specified file system does not exist. | |
| 404 | InvalidAccessGroup.NotFound | The specified AccessGroup does not exist. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。