NetBackup™ for Apache Cassandra 管理指南

Last Published:
Product(s): NetBackup (11.1)

使用 API 管理、保护或恢复 Cassandra 资产

在本文档中，您将找到有关用于 Cassandra 工作负载操作的 NetBackup API 的详细信息。这些操作包括资产管理、过滤、排序、恢复管理和保护计划管理。对于每个 API 端点，用户可以在本文档中找到有关请求、响应、错误和负载的详细信息。

有关 API 的信息，请参见以下内容：

创建或更新 Cassandra 资产

API 创建请求的 Cassandra 资产 - Cassandra 群集、Cassandra 节点、DSS 群集和 DSS 节点。

请求负载可以包含有关单个资产或资产组合的详细信息。可以通过两个步骤创建或更新 Cassandra 资产：

  • 要检索生成的 ID，必须发出 POST 请求。

  • 必须发出 GET 请求，这样才能将资产保存在数据库中。

表：1. Cassandra 群集和 Cassandra 节点的请求参数

API

重要变量和选项

https://PrimaryerverName

/netbackup/asset-service/queries/

  • Workloads：Cassandra

  • assetType：定义资产类型 - cluster

  • credentialName：用于资产服务的凭据名称。

  • workloadType：Cassandra

  • clusterName：有效的 Cassandra 群集名称。

https://PrimaryServerName
/netbackup/asset-service/queries/

  • Workloads：Cassandra

  • assetType：定义资产类型 - node

  • workloadType：Cassandra

表：2. 3. 数据暂存群集和节点的请求参数

API

重要变量和选项

https://PrimaryServerName
/netbackup/asset-service/queries/

  • Workloads：Cassandra

  • assetType：定义资产类型 - cluster、node、dataStagingCluster

  • workloadType：Cassandra

  • clusterName：有效的 Cassandra 群集名称。

https://PrimaryServerName
/netbackup/asset-service/queries/

  • Workloads：Cassandra

  • assetType：定义资产类型 - dataStagingNode。

  • workloadType：Cassandra

表：响应参数

API

重要变量和选项

https://PrimaryServerName
/netbackup/asset-service/queries/
Response parameters

  • type：查询响应类型的名称。

  • id：资产创建/修改的响应 ID

  • links：完整资产链接

方法：GET

使用此 API 将资产存储在 NetBackup 数据库中。它在 URL 中使用具有有效资产响应 ID 的 GET 方法。

表：将资产存储到数据库的响应

API

重要变量和选项

https://PrimaryServerName
/netbackup/asset-service/queries/
Asset Response ID

  • id：create-or-update-assets 查询的响应资产 ID

  • status：资产响应状态 - 成功、失败和正在进行中

  • percentComplete：完成百分比

  • totalWorkItems：响应项目的数量

  • totalSuccessfulWorkItems：成功项目的数量

  • totalFailedWorkItems：失败项目的数量

  • totalInProgressWorkItems

删除资产负载

可以使用此 API 从 NetBackup 数据库中删除特定资产或所有资产。可以删除单独 assetType，例如一个节点或 dataStagingNode。如果使用此 API 删除 assetType（如 cluster 或 dataStagingCluster），则它会删除与群集或 dataStagingCluster 关联的所有对应子节点。

表：删除资产的请求负载

API 选项

重要变量和选项

https://PrimaryServerName
/netbackup/asset-service/queries

  • type：查询响应类型的名称。

  • queryName：用于创建或更新不同资产的查询名称

  • workloads - Cassandra

  • correlationId - 它是用于跟踪工作项目的标识符

  • id - 分配给资产的 ID

  • assetType - 资产类型 {node, dataStagingNode, dataStagingCluster, cluster}

从数据库中删除资产的请求负载

可以使用此 API 删除数据库资产。这是与从上一个请求收到的删除响应 ID 一起使用的第二个请求。

表：

方法

URL

GET

 
https://PrimaryServerName
/netbackup/asset-service/queries/
Asset Delete Response ID

例如：bcc0eb1f-6613-427d-8101-19376fd689f7

表：从数据库中删除资产的响应

API

重要变量和选项

https://PrimaryServerName
/netbackup/asset-service/queries/
Asset Delete Response ID

例如：bcc0eb1f-6613-427d-8101-19376fd689f7

  • type - 操作响应类型的名称

  • id - 常规 delete-assets 的响应 ID

  • status - 资产响应状态 - 成功

  • percentComplete - 完成百分比

  • totalWorkItems - 响应工作项目的总数

  • totalSuccessfulWorkItems - 成功工作项目的总数

  • totalFailedWorkItems - 失败工作项目的总数

  • totalInProgressWorkItems - 正在进行的工作项目总数

  • correlationId - 它是用于跟踪工作项目的标识符

  • status - 资产响应状态

  • message - 资产响应消息

  • percentComplete - 完成百分比

  • offset

  • limit

  • hasNext

  • first

表：获取所有资产的请求

 

https://PrimaryServerName
/netbackup/asset-service/
workloads/cassandra/assets

Assets

获取所有资产的响应

所有资产均按默认降序列出，请参考“按 ID 获取资产”表以了解响应参数详细信息。根据“按 ID 获取资产”表，所有资产均按默认降序列出。

按 ID 获取资产

此 API 用于获取特定资产详细信息。可以使用此 API 获取有关特定资产的详细信息。

方法：GET

表：

API

重要变量和选项

https://PrimaryServerName/
netbackup/asset-service/workloads/
cassandra/assets/Asset ID

  • type - 操作响应类型的名称

  • id - 常规 delete-assets 的响应 ID

  • assetType - 定义资产类型

  • displayName - 资产名称

  • providerGeneratedId - 为资产自动生成的 ID

https://PrimaryServerName/
netbackup/asset-service/workloads/
cassandra//Asset ID

  • parentProviderGeneratedId - 为节点和 dataStagingNode 自动生成的 ID

  • clusterName - Cassndra

过滤器

过滤器可以应用于以下任何 API 端点：

  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'cluster'
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'node'
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'dataStagingCluster'
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'dataStagingNode'
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'node' and parentProviderGeneratedId eq '
CASSANDRA_cluster_Cassandra10'
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'cluster' and commonAssetAttributes/
providerGeneratedId eq 'CASSANDRA_cluster_Cassandra1'
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'cluster' and 
dataStagingClusterName eq 'DSS1'
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'cluster' and 
backupDataCenterName eq 'earthCenter'
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'node' and 
nodeIp eq '10.221.110.234'
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=(assetType eq 'cluster') and 
(contains(tolower(clusterName), 'cassandra1'))
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=(assetType eq 'cluster') and 
(clusterName eq 'Cassandra1')&meta=accessControlId
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'cluster' and 
clusterName eq 'Cassandra10'

表：

过滤器

参数

过滤条件

值

描述

assetType/
queryName/
workloads/
correlationId/
credentialName/
workloadType/
displayName/
clusterName/
dataStaging
ClusterName/
backupData
CenterName/
nodeDownThreshold
Percentage/
parentProvider
Generated

eq

cluster, node, dataStagingCluster and dataStagingNode

基于资产类型的资产过滤器

eq

'node' and parentProviderGeneratedId

eq 'CASSANDRA_cluster_Cassandra1'

 

eq

'cluster' and commonAssetAttributes/

providerGeneratedId eq 'CASSANDRA_cluster_Cassandra1'

 

eq

'cluster' and dataStagingClusterName

eq 'DSS1'

 

eq

'cluster' and backupDataCenterName

eq 'earthCenter'

 

eq

'node' and nodeIp

eq '10.221.105.94'

 

eq

(assetType eq 'cluster') and

(contains(tolower(clusterName), 'cassandra1'))

 

eq

(assetType eq 'cluster') and

(clusterName eq

'Cassandra1')&meta=accessControlId

 
排序

排序可以应用于以下任何 API 端点：

  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'cluster'&sort=clusterName
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'cluster'&sort=-clusterName
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'cluster'&sort=commonAssetAttributes.
credentials.credentialName
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'cluster'&sort=-commonAssetAttributes
.credentials.credentialName
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'node'&sort=
parentProviderGeneratedId
  • https://PrimaryServerName/netbackup/asset-service/workloads/cassandra/
assets?filter=assetType eq 'node'&sort=
-parentProviderGeneratedId

表：

过滤器参数

过滤条件

值

描述

assetType

eq

cluster'&sort=clusterName

 

assetType

eq

node and parentProviderGeneratedId eq 'CASSANDRA_cluster_Cassandra1

 

assetType

eq

cluster'&sort=

commonAssetAttributes

.credentials.credentialName

 

assetType

eq

'cluster'&sort=-commonAssetAttributes.

credentials.credentialName

 

assetType

eq

'node'&sort=

 

assetType

eq

parentProvider

GeneratedId

 

assetType

eq

'node'

&sort=-parentProvider

GeneratedId

 
保护计划

以下 API 创建或更新策略，该策略用于针对关联资产触发实际备份操作。这些 API 有助于为增量式备份和完全备份创建或更新策略。根据创建的策略，备份作业将按照提供的日程表详细信息自动被触发。

表：创建 SLO：完全备份和差异增量式备份

方法

POST

https://PrimaryServerName/
netbackup/servicecatalog/slos
 

表： 创建 SLO 的请求负载：

API

重要变量和选项

https://PrimaryServerName
/netbackup/servicecatalog/slos

  • name

  • scheduleType

  • backupStorageUnit

  • dayOfWeek

  • startSeconds

  • durationSeconds

  • frquencySeconds

  • workloadType

  • policyNamePrefix

  • policyDefinition

表：创建 SLO 的响应

API

重要变量和选项

https://PrimaryServerName/
netbackup/servicecatalog/slos

  • 201 - 已成功创建 SLO 定义。

  • 400 - 请求错误

  • 401 - 缺少授权标头，令牌无效，或者您无权执行此操作。

  • 409 - 已存在具有相同名称的 SLO。

  • 500 - 发生意外系统错误。

创建订购

表：

方法

POST

https://{{hostname}}/netbackup/
servicecatalog/slos/
{{newsloid}}/subscriptions
 

表：创建订购的请求负载：

API

重要变量和选项

https://{{hostname}}/netbackup/
servicecatalog/slos/
{{newsloid}}/subscriptions

  • selectionId

  • selectionType

表：创建订购的响应

API

重要变量和选项

https://{{hostname}}/netbackup/
servicecatalog/slos/
{{newsloid}}/subscriptions

  • 201 - 已成功创建订购

  • 400 - 请求错误

  • 401 - 缺少授权标头，令牌无效，或者您无权执行此操作。

  • 409 - 已存在具有相同名称的 SLO。

  • 500 - 发生意外系统错误。

发现

发现 API 可实际启动或停止对给定资产的发现。

表：启动发现

API

重要变量和选项

https://{{HOSTNAME}}/netbackup/
admin/discovery/workloads/cassandra/start

  • Data

  • Type

  • Attribute

  • serverName

表： 停止发现

API

重要变量和选项

https://{{HOSTNAME}}/netbackup/admin/
discovery/workloads/cassandra/stop

  • Data

  • Type

  • Attribute

  • serverName

恢复请求

恢复 API 根据恢复点、源、目标等详细信息，执行特定 Cassandra 资产的实际恢复。

表：

API

重要变量和选项

POST /recovery/workloads/cassandra/
scenarios/cluster/recover

  • Data

  • Type

  • Attribute

  • recoveryPoint

  • client

  • filter

  • backupId

  • recoveryObject

  • clusterNewName

  • recoveryOptions

  • backupHost

  • additionalBackupHosts

  • nbu-backup-host2

  • nbu-backup-host3

  • nbu-backup-host4

  • overwrite

  • restoreSelections

  • selectionType

  • selectionCriteria

  • keyspace

表：恢复 API 的响应

API

重要响应代码

POST /recovery/workloads/cassandra/
scenarios/cluster/recover

  • 201 - 恢复作业已成功启动。

  • 400 - 未找到某些必需属性，或者指定的客户端、备份映像或输入 JSON 无效。

  • 401 - 缺少授权标头，令牌无效，或者您无权执行此操作。

  • 404 - 未找到指定的客户端或备份映像

  • 406 - 接受类型无效。确保您的接受标头与此 API 生成的内容匹配

  • 415 - 不支持的介质类型。此 API 不支持在 Content-Type 标头中指定的介质类型。

  • 500 - 内部服务器错误。无法启动恢复。

  • 503 - 服务器正忙。无法启动恢复。