DescribeColdStorageInstance - 描述冷存储实例_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

查询冷存储实例信息。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardb:DescribeColdStorageInstance

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	否	PolarDB 集群 ID。	pc-wz9062015ly7526jc
NextToken	string	否	查询凭证（token），取值为上一次 api 调用返回的 nexttoken 参数值。如果没有下一个查询，请不传。	c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==
TableName	string	否	数据表名。	account_log
DBName	string	否	数据库名称。	test_db
DownloadNetType	string	否	下载链接的网络类型。	PUBLIC
DescribeType	string	否	内核参数，取值范围如下： Normal：内核参数列表 MigrationFromRDS：rds 参数比对	Normal
EngineType	string	否	支持引擎的类型，返回值是由下列引擎类型的值做加法运算后得到的。 1: 搜索引擎 2: 时序引擎 4: 宽表引擎 8: 文件引擎说明例如：EngineType 值为 15，15=8+4+2+1，表示该实例支持搜索引擎、时序引擎、宽表引擎和文件引擎。EngineType 值为 6，6=4+2，表示该实例支持时序引擎和宽表引擎。	2
RegionId	string	否	地域 ID。说明您可以调用 DescribeRegions 接口查看目标账号下所有的集群的地域信息。若该参数留空，默认查询当前账号下所有地域内的计划任务。	cn-hangzhou
MaxResults	integer	否	如果您不指定 MaxResults 参数的值，则表示您不需要分批次查询。调用接口后返回参数 MaxResults 的值表示列表条目总数。如果您指定 MaxResults 参数的值，则表示您需要分批次查询，MaxResults 的值表示分批次查询时每次显示的条目数。取值范围：1~100。调用接口后返回参数 MaxResults 的值表示当前查询批次下列表条目的数量。建议指定 MaxResults 参数的值为 20。	50
ExpireTime	integer	否	集群到期时间。说明仅付费方式为 Prepaid（包年包月）的集群会返回具体参数值，Postpaid（按量付费）集群则返回空值。	2020-11-14T16:00:00Z
PageNumber	string	否	页码	1
PageSize	string	否	每页大小	1
ObjectType	string	否	对象类型：TABLE、PARTITION_TABLE、LOB	TABLE

返回参数

名称	类型	描述	示例值
	object
PageRecordCount	integer	本页记录数。	1
RequestId	string	请求 ID。	C7A8EA8E-A140-5226-90D7-5BCB304D3DB6
NextToken	string	查询凭证（token），取值为上一次 api 调用返回的 nexttoken 参数值。如果没有下一个查询，请不传。	c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==
DownLoadUrl	string	冷存下载链接。	http://xxxx
OssClusterEnabled	string	是否开启 oss 存储空间： true：开启 false：关闭。	true
SupportOssCluster	string	当前集群是否支持开启冷存，不支持的集群，页面不会展示开关。	true
ObjectType	string	对象类型	TABLE
MaxResults	integer	本次读取的最大数据量，默认值为 10。	1000
PageSize	integer	每页条数	30
PageNumber	integer	当前页码	1
TotalRecord	integer	总记录数	1
Tables	array<object>	冷存储实例列表。
	object	冷存储实例列表。
OssClusterId	string	oss 集群 id。	pc-*****************
Partion	string	冷存储实例分区。	202509
Size	string	冷存储实例的磁盘大小，单位为 gib。	30
DB	string	数据库名。	test_db
Table	string	表名称。	user
TableName	string	表名称。	test_table
DBName	string	数据库名称。	test_db
Status	string	任务状态。	Running
FieldName	string	LOB 字段名。	user
ChildObjects	array<object>	子对象列表。
	object	子对象。
ObjectName	string	对象名称	img/1728554006462.png
ObjectType	string	对象类型。	File
Size	string	磁盘大小，单位 GiB。	10
Status	string	任务状态，取值范围如下： Scheduled：等待执行 Running：执行中 Succeed：执行成功 Cancelling：正在终止 Canceled：已终止 Waiting：等待预设时间如需查询多个状态则用英文逗号分隔，默认为空，表示全选。	Running
OssClusterInfoList	array<object>	冷存储实例的 oss 地址列表。
	object	冷存储实例的 oss 地址。
OssClusterId	string	冷存实例 ID。	pc-*****************
Region	string	任务所在地域的地域 ID。	cn-hangzhou
Size	string	冷存表大小，单位 gb。	50
CreatedTime	string	集群创建时间。	2023-05-10T17:01:16Z

示例

正常返回示例

JSON格式

{
  "PageRecordCount": 1,
  "RequestId": "C7A8EA8E-A140-5226-90D7-5BCB304D3DB6",
  "NextToken": "c2FpXzIwMjIwNjI5X2Jhay9zYWlfc3VtbWVyX3RyZWFzdXJlX3Bvb2xfbG9nLkNTVg==",
  "DownLoadUrl": "http://xxxx",
  "OssClusterEnabled": "true",
  "SupportOssCluster": "true",
  "ObjectType": "TABLE",
  "MaxResults": 1000,
  "PageSize": 30,
  "PageNumber": 1,
  "TotalRecord": 1,
  "Tables": [
    {
      "OssClusterId": "pc-*****************",
      "Partion": "202509",
      "Size": "30",
      "DB": "test_db",
      "Table": "user",
      "TableName": "test_table",
      "DBName": "test_db",
      "Status": "Running",
      "FieldName": "user",
      "ChildObjects": [
        {
          "ObjectName": "img/1728554006462.png",
          "ObjectType": "File",
          "Size": "10",
          "Status": "Running"
        }
      ]
    }
  ],
  "OssClusterInfoList": [
    {
      "OssClusterId": "pc-*****************",
      "Region": "cn-hangzhou",
      "Size": "50",
      "CreatedTime": "2023-05-10T17:01:16Z"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	指定的参数PageSize无效
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	指定的参数PageNumber无效
400	Database.ConnectError	db instance %s connect failed, please check instance status and database processlist	数据库实例连接失败，请检查实例状态和数据库进程列表
400	Account.QueryError	Instance %s query account error	实例%s查询帐户错误
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	当前的记录中不存在提供的DBClusterId。
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	指定的参数DBClusterId无效

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

变更历史

更多信息，参考变更详情。