DescribeEnterpriseSnapshotPolicy - 查找企业级快照策略 - 云服务器 ECS

调用DescribeEnterpriseSnapshotPolicy接口，并可以指定PolicyIds、ResourceGroupId、Tag等参数，查找企业级快照策略。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
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 列表。
PolicyId	string	否	策略 ID。	esp-xxx
DiskIds	array	否	磁盘 ID 列表
DiskId	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]。
Tag	object	否	标签。
Key	string	是	资源的标签键。	tag-key
Value	string	是	资源的标签值。	tag-value

返回参数

名称	类型	描述	示例值
	object	应答
Policies	array<object>	策略列表
Policie	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	cron tab 表达式	1 1 1 /1 ?
RetainRule	object	快照策略保留规则
Number	integer	个数	10
TimeInterval	integer	保留时间值	14
TimeUnit	string	保留时间单位	DAYS
StorageRule	object	快照策略存储规则
EnableImmediateAccess	boolean	是否启动快照极速可用	false
CrossRegionCopyInfo	object	快照复制信息
Enabled	boolean	是否启用跨地域复制	true
Regions	array<object>	目的地域信息
Region	object	拷贝目标地域信息
RegionId	string	快照复制目的地	cn-hangzhou
RetainDays	integer	目的地快照保留天数	7
CreateTime	string	创建时间	2023-06-24T06:03:35Z
TargetCount	integer	已经绑定的目标个数	10
Tags	array<object>	the pair tags
Tag	object
TagKey	string	资源的标签键	key
TagValue	string	资源的标签值	value
ResourceGroupId	string	the resource group	rg-xxx
SpecialRetainRules	object	快照策略特殊保留规则
Enabled	boolean	是否启用特殊保留时间	true
Rules	array<object>	特殊保留规则
Rule	object	特殊保留规则
SpecialPeriodUnit	string	特殊周期单位	WEEKS
TimeInterval	integer	保留时间值	1
TimeUnit	string	保留时间单位	WEEKS
DiskIds	array	已绑定的磁盘列表
DiskId	string	磁盘 ID。	"d-bp67acfmxazb4p****"
PageNumber	integer	分页模式查询时的页数。	1
PageSize	integer	分页模式查询时的单页记录数量。	10
TotalCount	long	总个数	10
RequestId	string	请求 ID	549BB71F-6778-53CE-AA73-E94ACE802AB4
NextToken	string	查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。	AAAAAdDWBF2****

示例

正常返回示例

JSON格式

{
  "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 status code	错误码	错误信息	描述
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.	返回值格式不正确（Format 不支持）。返回格式支持 XML 与 JSON，默认为 XML。
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.	参数缺失。
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.	相同clientToken的请求正在执行，请稍后再重试。
403	NoPermission.SLR	The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.	当前用户无权限创建SLR。
403	OperationDenied	The operation is not allowed.	当前操作不允许执行。
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.	找不到指定的 API。请检查调用的 URL 和方法。您调用的 API 不存在。请检查 API 的名称是否正确，请注意确认大小写。
404	NoSuchResource	The specified resource does not exist.	指定的资源不存在。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部错误。
504	RequestTimeout	The request is timeout, please try again later.	该请求超时，请稍后再重试。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-10-08	OpenAPI 错误码发生变更	查看变更详情
2024-01-08	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情