Files
aliyun-openapi-cpp-sdk/polardb/2017-08-01/DescribeDetachedBackups.xml
2021-03-08 12:06:57 +00:00

2 lines
8.0 KiB
XML

<?xml version='1.0' encoding='UTF-8'?><Api responseBodyIsOriginalObject="" authType="AK" responseLog="disable" isolationType="outer" parameterType="Single" product="polardb" visibility="Public" akProvenStatus="Disable" version="2017-08-01" keepClientResourceOwnerId="false" name="DescribeDetachedBackups" showJsonItemName="true" status="online"><IsvProtocol protocol="HTTPS|HTTP" method="POST|GET" /><ErrorMapping exceptionExpress="success=false,code,message,httpStatusCode"><ErrorCodes><ErrorCode code="InvalidDBInstance.NotFound" errorCode="InvalidDBCluster.NotFound" type="user" httpCode="404" errorMessage="The DBClusterId provided does not exist in our records." /></ErrorCodes></ErrorMapping><IspProtocol interface="com.aliyun.phoenix.polardb.service.v20170801.BackupService" timeout="10000" protocol="dubbo" invokeType="com.aliyun.phoenix.polardb.service.v20170801.domain.request.DescribeDetachedBackupsRequest" method="describeDetachedBackups" version="1.0.0" retries="-1" /><Parameters><Parameter name="callerBid" tagName="callerBid" type="String" required="false" tagPosition="System" checkBlank="false"/><Parameter name="callerUid" tagName="callerUid" type="Long" required="false" tagPosition="System" checkBlank="false"/><Parameter name="callerType" tagName="callerType" type="String" required="false" tagPosition="System" checkBlank="false"/><Parameter name="subCallerParentId" tagName="callerParentId" type="Long" required="false" tagPosition="System" checkBlank="false"/><Parameter name="stsSecurityToken" tagName="SecurityToken" type="String" required="false" tagPosition="System" checkBlank="false"/><Parameter name="stsAccessKeyId" tagName="AccessKeyId" type="String" required="false" tagPosition="Query" checkBlank="false" visibility="Public"/><Parameter name="sslCallerIp" tagName="app_ip" type="String" required="false" tagPosition="System" checkBlank="false"/><Parameter name="sslCallerSecurityTransport" tagName="security_transport" type="Boolean" required="false" tagPosition="System" checkBlank="false"/><Parameter name="sslProxyTrustTransportInfo" tagName="proxy_trust_transport_info" type="Boolean" required="false" tagPosition="System" checkBlank="false"/><Parameter name="sslProxyCallerSecurityTransport" tagName="proxy_original_security_transport" type="Boolean" required="false" tagPosition="System" checkBlank="false"/><Parameter name="sslProxyCallerIp" tagName="proxy_original_source_ip" type="String" required="false" tagPosition="System" checkBlank="false"/><Parameter name="mfaPresent" tagName="ak_mfa_present" type="Boolean" required="false" tagPosition="System" checkBlank="false"/><Parameter name="requestId" tagName="RequestId" type="String" required="false" tagPosition="System" checkBlank="false"/><Parameter name="appKey" tagName="AccessKeyId" type="String" required="false" tagPosition="Query" checkBlank="false" visibility="Public"/><Parameter name="apiName" tagName="Action" type="String" required="false" tagPosition="Query" checkBlank="false" visibility="Public"/><Parameter name="clientIP" tagName="app_ip" type="String" required="false" tagPosition="System" checkBlank="false"/><Parameter name="ownerId" tagName="OwnerId" type="Long" required="false" tagPosition="Query" checkBlank="false" visibility="Public"/><Parameter name="callerUidLoginEmail" tagName="callerUidEmail" type="String" required="false" tagPosition="System" checkBlank="false"/><Parameter name="callerBidLoginEmail" tagName="callerBidEmail" type="String" required="false" tagPosition="System" checkBlank="false"/><Parameter name="ownerIdLoginEmail" tagName="ownerIdLoginEmail" type="String" required="false" tagPosition="System" checkBlank="false"/><Parameter name="resourceOwnerAccount" tagName="ResourceOwnerAccount" type="String" required="false" tagPosition="Query" checkBlank="false" visibility="Public"/><Parameter name="resourceOwnerId" tagName="ResourceOwnerId" type="Long" required="false" tagPosition="Query" checkBlank="false" visibility="Public"/><Parameter name="enable" tagName="enable" type="Boolean" required="false" tagPosition="System" checkBlank="false"/><Parameter name="requestContent" tagName="requestContent" type="String" required="false" tagPosition="System" checkBlank="false"/><Parameter name="ownerAccount" tagName="OwnerAccount" type="String" required="false" tagPosition="Query" checkBlank="false" visibility="Public"/><Parameter name="product" tagName="Product" type="String" required="false" tagPosition="System" checkBlank="false" defaultValue="polardb"/><Parameter name="category" tagName="Category" type="String" required="false" tagPosition="System" checkBlank="false" defaultValue="dbcluster"/><Parameter name="dbClusterId" tagName="DBClusterId" type="String" required="true" tagPosition="Query" docRequired="true" checkBlank="false" visibility="Public"/><Parameter name="backupId" tagName="BackupId" type="String" required="false" tagPosition="Query" checkBlank="false" visibility="Public"/><Parameter name="backupStatus" tagName="BackupStatus" type="String" required="false" tagPosition="Query" checkBlank="false" visibility="Public"/><Parameter name="backupMode" tagName="BackupMode" type="String" required="false" tagPosition="Query" checkBlank="false" visibility="Public"/><Parameter name="startTime" tagName="StartTime" type="String" required="true" tagPosition="Query" docRequired="true" checkBlank="false" visibility="Public"/><Parameter name="endTime" tagName="EndTime" type="String" required="true" tagPosition="Query" docRequired="true" checkBlank="false" visibility="Public"/><Parameter name="pageSize" tagName="PageSize" type="Integer" required="false" tagPosition="Query" checkBlank="false" defaultValue="30" minValue="30" maxValue="100" visibility="Public"/><Parameter name="pageNumber" tagName="PageNumber" type="Integer" required="false" tagPosition="Query" checkBlank="false" minValue="1" maxValue="2147483647" visibility="Public"/></Parameters><FlowControl controlUnit="Minute" apiDefault="120" /><ResultMapping><Member tagName="RequestId" visibility="Public" type="String" name="requestId"/><Member tagName="TotalRecordCount" visibility="Public" type="String" name="data.totalRecords"/><Member tagName="PageNumber" visibility="Public" type="String" name="data.pageNumbers"/><Member tagName="PageRecordCount" visibility="Public" type="String" name="data.backupsetNumbers"/><Array tagName="Items" visibility="Public" itemName="Backup" name="data.backupsetItems" nullToEmpty="true"><Member tagName="BackupId" visibility="Public" type="String" name="backupSetId"/><Member tagName="DBClusterId" visibility="Public" type="String" name="dbInstanceId"/><Member tagName="BackupStatus" visibility="Public" type="String" name="backupSetStatus"><Switch><Case value="0" tagValue="Success"/><Case value="1" tagValue="Failed"/></Switch></Member><Member tagName="BackupStartTime" visibility="Public" type="String" name="backupStartTime"/><Member tagName="BackupEndTime" visibility="Public" type="String" name="backupEndTime"/><Member tagName="BackupType" visibility="Public" type="String" name="backupType"><Switch><Case value="F" tagValue="FullBackup"/><Case value="I" tagValue="IncrementalBackup"/></Switch></Member><Member tagName="BackupMode" visibility="Public" type="String" name="jobMode"><Switch><Case value="0" tagValue="Automated"/><Case value="1" tagValue="Manual"/></Switch></Member><Member tagName="BackupMethod" visibility="Public" type="String" name="backupMethod"><Switch><Case value="L" tagValue="Logical"/><Case value="P" tagValue="Physical"/><Case value="S" tagValue="Snapshot"/></Switch></Member><Member tagName="StoreStatus" visibility="Public" type="String" name="storeStatus"><Switch><Case value="enabled" tagValue="Enabled"/><Case value="disabled" tagValue="Disabled"/></Switch></Member><Member tagName="BackupSetSize" visibility="Public" type="String" name="backupSetSize"/><Member tagName="ConsistentTime" visibility="Public" type="String" name="consistentTime"/><Member tagName="BackupsLevel" visibility="Public" type="String" name="backupsLevel"/><Member tagName="IsAvail" visibility="Public" type="String" name="isAvail"/></Array></ResultMapping></Api>