DescribeDBClusters.xml 13 KB

1
  1. <?xml version='1.0' encoding='UTF-8'?><Api responseBodyIsOriginalObject="" authType="AK" responseLog="enable" isolationType="outer" parameterType="Single" product="adb" visibility="Public" akProvenStatus="Disable" version="2019-03-15" keepClientResourceOwnerId="false" name="DescribeDBClusters" showJsonItemName="true" status="online"><IsvProtocol protocol="HTTPS|HTTP" method="POST|GET" /><ErrorMapping exceptionExpress="success=false,code,message,httpStatusCode"><ErrorCodes><ErrorCode code="InternalError" errorCode="InternalError" type="user" httpCode="500" errorMessage="An error occurred while processing your request." /><ErrorCode code="ServiceUnavailable" errorCode="ServiceUnavailable" type="user" httpCode="503" errorMessage="An error occurred while processing your request." /></ErrorCodes></ErrorMapping><IspProtocol interface="com.aliyun.phoenix.adb.service.v20190315.DbClusterService" timeout="10000" protocol="dubbo" invokeType="com.aliyun.phoenix.adb.service.v20190315.domain.request.DescribeDBClustersRequest" method="describeDBClusters" 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" docRequired="true" 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="adb"/><Parameter name="category" tagName="Category" type="String" required="false" tagPosition="System" checkBlank="false" defaultValue="dbcluster"/><Parameter name="regionId" tagName="RegionId" type="String" required="true" tagPosition="Query" docRequired="true" checkBlank="false" visibility="Public"/><Parameter name="dbClusterIds" tagName="DBClusterIds" type="String" required="false" tagPosition="Query" checkBlank="false" visibility="Public"/><Parameter name="dbClusterDescription" tagName="DBClusterDescription" type="String" required="false" tagPosition="Query" checkBlank="false" visibility="Public"/><Parameter name="dbClusterStatus" tagName="DBClusterStatus" type="String" required="false" tagPosition="Query" checkBlank="false" visibility="Public"><Switch><Cases><Case value="CREATING" tagValue="Creating"/><Case value="ACTIVATION" tagValue="Running"/><Case value="DELETING" tagValue="Deleting"/><Case value="SCALING_OUT" tagValue="ScalingOut"/><Case value="NET_CREATING" tagValue="NetAddressCreating"/><Case value="NET_DELETING" tagValue="NetAddressDeleting"/><Case value="PREPARING" tagValue="Preparing"/><Case value="SCALING_IN" tagValue="ScalingIn"/><Case value="BACKUP_RECOVERING" tagValue="Restoring"/><Case value="CLASS_CHANGING" tagValue="ClassChanging"/><Case value="NET_MODIFYING" tagValue="NetAddressModifying"/><Case value="ENGINE_VERSION_UPGRADING" tagValue="EngineVersionUpgrading"/></Cases></Switch></Parameter><Parameter name="pageSize" tagName="PageSize" type="Integer" required="false" tagPosition="Query" checkBlank="false" defaultValue="30" visibility="Public"/><Parameter name="pageNumber" tagName="PageNumber" type="Integer" required="false" tagPosition="Query" checkBlank="false" defaultValue="1" visibility="Public"/><Parameter name="tags" tagName="Tag" type="RepeatList" required="false" tagPosition="Query" checkRepeatListAll="false" maxNumber="21" indexName="tagIndex" sequence="true" invokeDataType="Map" visibility="Public"><Parameters><Parameter name="key" tagName="Key" type="String" required="false" checkRepeatListAll="false" checkBlank="false" visibility="Public"/><Parameter name="value" tagName="Value" type="String" required="false" checkRepeatListAll="false" checkBlank="false" visibility="Public"/></Parameters></Parameter><Parameter name="resourceGroupId" tagName="ResourceGroupId" type="String" required="false" tagPosition="Query" checkBlank="false" visibility="Public"/></Parameters><FlowControl controlUnit="Minute" userDefault="500" apiDefault="1000" /><ResultMapping><Member tagName="RequestId" visibility="Public" type="String" name="requestId"/><Member tagName="PageNumber" visibility="Public" type="Integer" name="data.pageNumber"/><Member tagName="TotalCount" visibility="Public" type="Integer" name="data.totalRecordCount"/><Member tagName="PageSize" visibility="Public" type="Integer" name="data.pageRecordCount"/><Array tagName="Items" visibility="Public" itemName="DBCluster" name="data.items" nullToEmpty="true"><Member tagName="DBClusterId" visibility="Public" type="String" name="dbClusterId"/><Member tagName="DBClusterType" visibility="Public" type="String" name="dbClusterType" nullToEmpty="true"><Switch><Case value="COMMON" tagValue="Common"/><Case value="READONLY" tagValue="Readonly"/><Case value="GUARD" tagValue="Guard"/></Switch></Member><Member tagName="DBClusterDescription" visibility="Public" type="String" name="dbClusterDescription" nullToEmpty="true"/><Member tagName="PayType" visibility="Public" type="String" name="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="RegionId" visibility="Public" type="String" name="regionId" nullToEmpty="true"/><Member tagName="ExpireTime" visibility="Public" type="String" name="expireTime"/><Member tagName="Expired" visibility="Public" type="String" name="expired"/><Member tagName="DBClusterStatus" visibility="Public" type="String" name="dbClusterStatus" nullToEmpty="true"><Switch><Case value="CREATING" tagValue="Creating"/><Case value="ACTIVATION" tagValue="Running"/><Case value="DELETING" tagValue="Deleting"/><Case value="SCALING_OUT" tagValue="ScalingOut"/><Case value="NET_CREATING" tagValue="NetAddressCreating"/><Case value="NET_DELETING" tagValue="NetAddressDeleting"/><Case value="PREPARING" tagValue="Preparing"/><Case value="SCALING_IN" tagValue="ScalingIn"/><Case value="BACKUP_RECOVERING" tagValue="Restoring"/><Case value="CLASS_CHANGING" tagValue="ClassChanging"/><Case value="NET_MODIFYING" tagValue="NetAddressModifying"/><Case value="ENGINE_VERSION_UPGRADING" tagValue="EngineVersionUpgrading"/></Switch></Member><Member tagName="DBVersion" visibility="Public" type="String" name="dbVersion" nullToEmpty="true"/><Member tagName="LockMode" visibility="Public" type="String" name="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="LockReason" visibility="Public" type="String" name="lockReason" nullToEmpty="true"/><Member tagName="CreateTime" visibility="Public" type="String" name="createTime" nullToEmpty="true"/><Member tagName="DBNodeStorage" visibility="Public" type="Long" name="dbNodeStorage" nullToEmpty="true"/><Member tagName="DBNodeClass" visibility="Public" type="String" name="dbNodeClass" nullToEmpty="true"/><Member tagName="DBNodeCount" visibility="Public" type="Long" name="dbNodeCount" nullToEmpty="true"/><Member tagName="CommodityCode" visibility="Public" type="String" name="commodityCode" nullToEmpty="true"/><Member tagName="Category" visibility="Public" type="String" name="category" nullToEmpty="true"><Switch><Case value="BASIC" tagValue="Basic"/><Case value="CLUSTER" tagValue="Cluster"/><Case value="PREMIUM" tagValue="Premium"/></Switch></Member><Member tagName="RdsInstanceId" visibility="Public" type="String" name="rdsInstanceId" nullToEmpty="true"/><Member tagName="DtsJobId" visibility="Public" type="String" name="dtsJobId" nullToEmpty="true"/><Member tagName="ExecutorCount" visibility="Public" type="String" name="executorCount" nullToEmpty="false"/><Member tagName="DiskType" visibility="Public" type="String" name="diskType" nullToEmpty="true"/><Member tagName="VPCCloudInstanceId" visibility="Public" type="String" name="vpcCloudInstanceId" nullToEmpty="true"/><Member tagName="Engine" visibility="Public" type="String" name="engine" nullToEmpty="true"/><Member tagName="DBClusterNetworkType" visibility="Public" type="String" name="clusterNetworkType" nullToEmpty="true"><Switch><Case value="vpc" tagValue="VPC"/></Switch></Member><Member tagName="VPCId" visibility="Public" type="String" name="vpcId" nullToEmpty="true"/><Member tagName="VSwitchId" visibility="Public" type="String" name="vswitchId" nullToEmpty="true"/><Member tagName="ZoneId" visibility="Public" type="String" name="zoneId" nullToEmpty="true"/><Member tagName="ConnectionString" visibility="Public" type="String" name="connectionString" nullToEmpty="true"/><Member tagName="Port" visibility="Public" type="String" name="port" nullToEmpty="true"/><Member tagName="ComputeResource" visibility="Public" type="String" name="computeResource" nullToEmpty="false"/><Member tagName="StorageResource" visibility="Public" type="String" name="storageResource" nullToEmpty="false"/><Member tagName="Mode" visibility="Public" type="String" name="mode" nullToEmpty="true"/><Member tagName="ResourceGroupId" visibility="Public" type="String" name="resourceGroupId" nullToEmpty="true"/><Member tagName="ElasticIOResource" visibility="Public" type="Integer" name="elasticIOResource" nullToEmpty="true"/><Array tagName="Tags" visibility="Public" itemName="Tag" name="tags" nullToEmpty="true"><Member tagName="Key" visibility="Public" type="String" name="key" nullToEmpty="true"/><Member tagName="Value" visibility="Public" type="String" name="value" nullToEmpty="true"/></Array></Array></ResultMapping></Api>