DescribeEnterpriseSnapshotPolicy - - Alibaba Cloud ドキュメントセンター

PolicyIds、ResourceGroupId、Tag などのパラメーターを指定して、エンタープライズレベルのスナップショットポリシーを照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ebs:DescribeEnterpriseSnapshotPolicy

list

*EnterpriseSnapshotPolicy

acs:ebs:{#regionId}:{#accountId}:enterprisesnapshotpolicy/{#EnterpriseSnapshotPolicyId}

*EnterpriseSnapshotPolicy

acs:ebs:{#regionId}:{#accountId}:enterprisesnapshotpolicy/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストを取得できます。	cn-hangzhou
PolicyIds	array	任意	スナップショットポリシーの ID のリスト。
	string	任意	ポリシーの ID。	esp-xxx
DiskIds	array	任意	クラウドディスクの ID のリスト。
	string	任意	クラウドディスクの ID。	"d-bp67acfmxazb4p****"
ResourceGroupId	string	任意	リソースグループの ID。	rg-acfmvs****
NextToken	string	任意	ページネーショントークン (Token)。このパラメーターには、前の呼び出しで返された NextToken の値を設定します。最初のリクエストでは、このパラメーターを設定する必要はありません。NextToken が指定されている場合、PageSize および PageNumber リクエストパラメーターは無効となり、応答内の TotalCount の値も無効になります。	AAAAAdDWBF2****
MaxResults	integer	任意	今回の呼び出しで返すエントリの最大値。このパラメーターは NextToken と併用できます。有効な値: 1～500。デフォルト値: 10。	100
PageSize	integer	任意	ページングクエリにおけるページサイズ。有効な値: 1～100。	10
PageNumber	integer	任意	ページングクエリにおけるページ番号。	1
ClientToken	string	任意	リクエストのべき等性を確保します。値はクライアント側で生成され、異なるリクエスト間で一意である必要があります。ClientToken には ASCII 文字のみを使用でき、長さは 64 文字以下にする必要があります。詳細については、「べき等性を確保する方法」をご参照ください。	0c593ea1-3bea-11e9-b96b-88e9fe63****
Tag	array<object>	任意	タグキーとタグ値のペア。N の有効な値: 1～20。
	object	任意	タグ。
Key	string	必須	リソースのタグキー。	tag-key
Value	string	必須	リソースのタグ値。	tag-value

レスポンスフィールド

フィールド	型	説明	例
	object	応答。
Policies	array<object>	ポリシーのリスト。
	array<object>	ポリシーの詳細。
Name	string	スナップショットポリシーの名前。	xxx
PolicyId	string	スナップショットポリシーの ID。	esp-xxx
TargetType	string	タイプ。有効な値: DISK	DISK
State	string	ステータス。有効な値: DISABLED ENABLED	DISABLED
ManagedForEcs	boolean	スナップショットの管理ステータス。	false
Desc	string	スナップショットポリシーの説明。	xxx
Schedule	object	スナップショットポリシーのスケジュールルール。
CronExpression	string	The cron expression of the enterprise-level snapshot policy.	1 1 1 /1 ?
RetainRule	object	スナップショットポリシーの保持ルール。
Number	integer	The maximum number of snapshots that can be retained.	10
TimeInterval	integer	The value of the retention period of snapshots.	14
TimeUnit	string	The unit of the retention period of snapshots.	DAYS
StorageRule	object	スナップショットポリシーのストレージルール。
EnableImmediateAccess	boolean	Indicates whether the instant access feature is enabled.	false
CrossRegionCopyInfo	object	スナップショットのクロスリージョンコピー情報。フォーマットに従います。
Enabled	boolean	Indicates whether the cross-region replication feature is enabled.	true
Regions	array<object>	The destination regions that store snapshot copies.
	object	Destination region information.
RegionId	string	The ID of the destination region.	cn-hangzhou
RetainDays	integer	The retention period of snapshot copies in the destination region. Unit: day.	7
CreateTime	string	協定世界時 (UTC) ISO 8601 フォーマットの作成時間。	2023-06-24T06:03:35Z
TargetCount	integer	バインドされたターゲットの数。	10
Tags	array<object>	タグペア。
	object
TagKey	string	The key of the tag of the enterprise-level snapshot policy.	key
TagValue	string	The value of the tag of the enterprise-level snapshot policy.	value
ResourceGroupId	string	リソースグループ。	rg-xxx
SpecialRetainRules	object	スナップショットポリシーの特別保持ルール。
Enabled	boolean	Indicates whether the special retention period is enabled.	true
Rules	array<object>	The special retention rules.
	object	The special retention rule.
SpecialPeriodUnit	string	The unit of the special retention period.	WEEKS
TimeInterval	integer	The value of the retention period.	1
TimeUnit	string	The unit of the retention period.	WEEKS
DiskIds	array	バインドされたクラウドディスクの ID のリスト。
	string	クラウドディスクの ID。	"d-bp67acfmxazb4p****"
PageNumber	integer	ページングクエリのページ番号。	1
PageSize	integer	ページングクエリにおけるページサイズ。	10
TotalCount	integer	エントリの総数。	10
RequestId	string	リクエスト ID。	549BB71F-6778-53CE-AA73-E94ACE802AB4
NextToken	string	次のクエリのために返されるページネーショントークン (Token)。	AAAAAdDWBF2****

例

成功レスポンス

JSONJSON

{
  "Policies": [
    {
      "Name": "xxx",
      "PolicyId": "esp-xxx",
      "TargetType": "DISK",
      "State": "DISABLED",
      "ManagedForEcs": false,
      "Desc": "xxx",
      "Schedule": {
        "CronExpression": "1 1 1 */1 * ?"
      },
      "RetainRule": {
        "Number": 10,
        "TimeInterval": 14,
        "TimeUnit": "DAYS"
      },
      "StorageRule": {
        "EnableImmediateAccess": false
      },
      "CrossRegionCopyInfo": {
        "Enabled": true,
        "Regions": [
          {
            "RegionId": "cn-hangzhou",
            "RetainDays": 7
          }
        ]
      },
      "CreateTime": "2023-06-24T06:03:35Z",
      "TargetCount": 10,
      "Tags": [
        {
          "TagKey": "key",
          "TagValue": "value"
        }
      ],
      "ResourceGroupId": "rg-xxx",
      "SpecialRetainRules": {
        "Enabled": true,
        "Rules": [
          {
            "SpecialPeriodUnit": "WEEKS",
            "TimeInterval": 1,
            "TimeUnit": "WEEKS"
          }
        ]
      },
      "DiskIds": [
        "\"d-bp67acfmxazb4p****\"\n"
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 10,
  "RequestId": "549BB71F-6778-53CE-AA73-E94ACE802AB4",
  "NextToken": "AAAAAdDWBF2****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter	The parameter %s is invalid.
400	InvalidParameter.Conflict	The specified parameter %s and %s are not blank at the same time.
400	InvalidParameter.Format	Specified parameter format is not valid.	日文说明
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
403	Forbidden	User is not authorized to operate.
403	Forbidden.Action	User is not authorized to operate this action.
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.
403	LastTokenProcessing	The last token request is processing.
403	NoPermission.SLR	The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.
403	OperationDenied	The operation is not allowed.
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	NoSuchResource	The specified resource does not exist.
504	RequestTimeout	The request is timeout, please try again later.

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

変更履歴

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