DescribeAccessGroups - File Storage NAS - Alibaba Cloud ドキュメントセンター

権限グループのフォーマット情報を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

nas:DescribeAccessGroups

list

*AccessGroup

acs:nas:{#regionId}:{#accountId}:accessgroup/{#accessgroupName}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AccessGroupName	string	任意	権限グループの名前。使用制限: 名前は 3～64 文字である必要があります。名前は文字で始まり、文字、数字、アンダースコア (_)、またはハイフン (-) を含めることができます。	DEFAULT_VPC_GROUP_NAME
PageSize	integer	任意	各ページの権限グループの数。有効な値: 1～100。デフォルト値: 10。	2
PageNumber	integer	任意	リストのページ番号。開始値 (デフォルト値): 1。	1
UseUTCDateTime	boolean	任意	返される時間が協定世界時 (UTC) フォーマットかどうかを指定します。有効な値: true (デフォルト): 返される時間は協定世界時 (UTC) フォーマットです。 false: 返される時間は協定世界時 (UTC) フォーマットではありません。	true
FileSystemType	string	任意	ファイルシステムタイプ。有効な値: standard (デフォルト): 汎用 NAS。 extreme: エクストリーム NAS。 cpfs: Cloud Parallel File Storage (CPFS)。列挙値: standard : 汎用 NAS。 cpfs : Cloud Paralleled File System。 extreme : エクストリーム NAS。	standard

レスポンスフィールド

フィールド	型	説明	例
	object
AccessGroups	object
AccessGroup	array<object>	権限グループのフォーマット情報のコレクション。
	object
AccessGroupName	string	権限グループの名前。	DEFAULT_VPC_GROUP_NAME
Description	string	権限グループの説明。	This is a test access group.
CreateTime	string	権限グループが作成された時刻。時刻は ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ 形式で返されます。	2020-01-05T16:00:00Z
AccessGroupType	string	権限グループのタイプ。値 Vpc は仮想プライベートクラウド（VPC）を示します。	Vpc
RuleCount	integer	権限グループ内の権限ルールの数。	0
MountTargetCount	integer	権限グループが適用されるマウントターゲットの数。	0
FileSystemType	string	ファイルシステムのタイプ。有効な値: standard（デフォルト）: 汎用 NAS。 extreme: Extreme NAS。 cpfs: Cloud Parallel File Storage（CPFS）。	standard
RegionId	string	リージョン ID。	cn-hangzhou
TotalCount	integer	権限グループの総数。	1
RequestId	string	リクエスト ID。	2514F97E-FFF0-4A1F-BF04-729CEAC6****
PageSize	integer	各ページの権限グループの数。	2
PageNumber	integer	リストのページ番号。	1

例

成功レスポンス

JSONJSON

{
  "AccessGroups": {
    "AccessGroup": [
      {
        "AccessGroupName": "DEFAULT_VPC_GROUP_NAME",
        "Description": "This is a test access group.",
        "CreateTime": "2020-01-05T16:00:00Z",
        "AccessGroupType": "Vpc",
        "RuleCount": 0,
        "MountTargetCount": 0,
        "FileSystemType": "standard",
        "RegionId": "cn-hangzhou"
      }
    ]
  },
  "TotalCount": 1,
  "RequestId": "2514F97E-FFF0-4A1F-BF04-729CEAC6****",
  "PageSize": 2,
  "PageNumber": 1
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。