DescribeDBClusterAttribute.xml 12 KB

1
  1. <?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="DescribeDBClusterAttribute" showJsonItemName="false" status="online"><IsvProtocol protocol="HTTP|HTTPS" 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.DbClusterService" timeout="10000" protocol="dubbo" invokeType="com.aliyun.phoenix.polardb.service.v20170801.domain.request.DescribeDBClusterAttributeRequest" method="describeDBClusterAttribute" 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"/></Parameters><FlowControl controlUnit="Minute" userDefault="200" apiDefault="20000" /><ResultMapping><Member tagName="DeletionLock" visibility="Public" type="Integer" name="data.deletionLock" nullToEmpty="true"/><Member tagName="Category" visibility="Public" type="String" name="data.category" nullToEmpty="true"/><Member tagName="ResourceGroupId" visibility="Public" type="String" name="data.resourceGroupId" nullToEmpty="false"/><Member tagName="DataLevel1BackupChainSize" visibility="Public" type="Long" name="data.snapshotSize" nullToEmpty="true"/><Member tagName="DBClusterId" visibility="Public" type="String" name="data.dbClusterId" nullToEmpty="true"/><Member tagName="DBClusterNetworkType" visibility="Public" type="String" name="data.clusterNetworkType" nullToEmpty="true"><Switch><Case value="vpc" tagValue="VPC"/><Case value="classic" tagValue="Classic"/></Switch></Member><Member tagName="DBType" visibility="Public" type="String" name="data.dbType" nullToEmpty="true"><Switch><Case value="mysql" tagValue="MySQL"/><Case value="ppas" tagValue="Oracle"/><Case value="pg" tagValue="PostgreSQL"/></Switch></Member><Member tagName="IsLatestVersion" visibility="Public" type="Boolean" name="data.isLatestVersion" nullToEmpty="true"/><Member tagName="DBVersion" visibility="Public" type="String" name="data.dbVersion" nullToEmpty="true"/><Member tagName="StorageMax" visibility="Public" type="Long" name="data.maxStorage" nullToEmpty="true"/><Member tagName="ZoneIds" visibility="Public" type="String" name="data.dataZoneIds" nullToEmpty="true"/><Member tagName="MaintainTime" visibility="Public" type="String" name="data.maintainTime" nullToEmpty="true"/><Member tagName="Engine" visibility="Public" type="String" name="data.engine" nullToEmpty="true"><Switch><Case value="polardb_mysql" tagValue="POLARDB"/><Case value="polardb_mysql_rw" tagValue="POLARDB"/><Case value="polardb_mysql_ro" tagValue="POLARDB"/><Case value="polardb_pg" tagValue="POLARDB"/><Case value="polardb_pg_ro" tagValue="POLARDB"/><Case value="polardb_pg_rw" tagValue="POLARDB"/><Case value="polardb_ppas" tagValue="POLARDB"/><Case value="polardb_ppas_ro" tagValue="POLARDB"/><Case value="polardb_ppas_rw" tagValue="POLARDB"/></Switch></Member><Member tagName="RequestId" visibility="Public" type="String" name="requestId"/><Member tagName="VPCId" visibility="Public" type="String" name="data.vpcId"/><Member tagName="DBClusterStatus" visibility="Public" type="String" name="data.dbClusterStatusDesc" nullToEmpty="true"><Switch><Case value="CREATING" tagValue="Creating"/><Case value="ACTIVATION" tagValue="Running"/><Case value="DELETING" tagValue="Deleting"/><Case value="RESTARTING" tagValue="Rebooting"/><Case value="NODE_CREATING" tagValue="DBNodeCreating"/><Case value="NODE_DELETING" tagValue="DBNodeDeleting"/><Case value="CLASS_CHANGING" tagValue="ClassChanging"/><Case value="NET_CREATING" tagValue="NetAddressCreating"/><Case value="NET_DELETING" tagValue="NetAddressDeleting"/><Case value="NET_MODIFYING" tagValue="NetAddressModifying"/><Case value="MINOR_VERSION_UPGRADING" tagValue="MinorVersionUpgrading"/><Case value="INS_MAINTAINING" tagValue="Maintaining"/><Case value="HA_SWITCHING" tagValue="Switching"/><Case value="TDE_MODIFYING" tagValue="TDEModifying"/><Case value="CONFIG_ENCRYPTING" tagValue="TDEModifying"/></Switch></Member><Member tagName="VSwitchId" visibility="Public" type="String" name="data.vswitchId"/><Member tagName="DBClusterDescription" visibility="Public" type="String" name="data.dbClusterDescription" nullToEmpty="true"/><Member tagName="Expired" visibility="Public" type="String" name="data.expired"/><Member tagName="LockMode" visibility="Public" type="String" name="data.lockMode" nullToEmpty="true"><Switch><Case value="0" tagValue="Unlock"/><Case value="1" tagValue="ManualLock"/><Case value="2" tagValue="LockByExpiration"/><Case value="3" tagValue="LockByRestoration"/><Case value="4" tagValue="LockByDiskQuota"/><Case value="5" tagValue="LockReaderByDiskQuota"/></Switch></Member><Member tagName="PayType" visibility="Public" type="String" name="data.payType" nullToEmpty="true"><Switch><Case value="postpay" tagValue="Postpaid"/><Case value="postpaid" tagValue="Postpaid"/><Case value="prepay" tagValue="Prepaid"/><Case value="prepaid" tagValue="Prepaid"/></Switch></Member><Member tagName="StorageUsed" visibility="Public" type="Long" name="data.usedStorage" nullToEmpty="true"/><Member tagName="DBVersionStatus" visibility="Public" type="String" name="data.dbVersionStatus" nullToEmpty="false"><Switch><Case value="1" tagValue="Stable"/><Case value="2" tagValue="Old"/><Case value="3" tagValue="HighRisk"/></Switch></Member><Member tagName="SubCategory" type="String" name="data.subCategory"/><Member tagName="CreationTime" visibility="Public" type="String" name="data.createTime" nullToEmpty="true"/><Member tagName="RegionId" visibility="Public" type="String" name="data.regionId" nullToEmpty="true"/><Member tagName="SQLSize" visibility="Public" type="Long" name="data.sqlSize" nullToEmpty="true"/><Member tagName="ExpireTime" visibility="Public" type="String" name="data.expireTime" nullToEmpty="true"/><Array tagName="DBNodes" visibility="Public" itemName="DBNode" name="data.items" nullToEmpty="true"><Member tagName="DBNodeStatus" visibility="Public" type="String" name="dbInstanceStatus" nullToEmpty="true"><Switch><Case value="CREATING" tagValue="Creating"/><Case value="ACTIVATION" tagValue="Running"/><Case value="DELETING" tagValue="Deleting"/><Case value="RESTARTING" tagValue="Rebooting"/><Case value="NODE_CREATING" tagValue="DBNodeCreating"/><Case value="NODE_DELETING" tagValue="DBNodeDeleting"/><Case value="CLASS_CHANGING" tagValue="ClassChanging"/><Case value="NET_CREATING" tagValue="NetAddressCreating"/><Case value="NET_DELETING" tagValue="NetAddressDeleting"/><Case value="NET_MODIFYING" tagValue="NetAddressModifying"/><Case value="MINOR_VERSION_UPGRADING" tagValue="MinorVersionUpgrading"/><Case value="INS_MAINTAINING" tagValue="Maintaining"/><Case value="HA_SWITCHING" tagValue="Switching"/></Switch></Member><Member tagName="MaxConnections" visibility="Public" type="Integer" name="maxConnections" nullToEmpty="true"/><Member tagName="ZoneId" visibility="Public" type="String" name="zoneId" nullToEmpty="true"/><Member tagName="DBNodeRole" visibility="Public" type="String" name="dbNodeRole" nullToEmpty="true"/><Member tagName="CreationTime" visibility="Public" type="String" name="dbInstanceCreateTime" nullToEmpty="true"/><Member tagName="DBNodeId" visibility="Public" type="String" name="dbInstanceId" nullToEmpty="true"/><Member tagName="FailoverPriority" visibility="Public" type="Integer" name="failoverPriority" nullToEmpty="true"/><Member tagName="DBNodeClass" visibility="Public" type="String" name="dbInstanceClass" nullToEmpty="true"/><Member tagName="MaxIOPS" visibility="Public" type="Integer" name="maxIOPS" nullToEmpty="true"/></Array><Array tagName="Tags" visibility="Public" itemName="Tag" name="data.tags" nullToEmpty="true"><Member tagName="Value" visibility="Public" type="String" name="value"/><Member tagName="Key" visibility="Public" type="String" name="key"/></Array></ResultMapping></Api>