DescribeHiTSDBInstance.xml 8.6 KB

1
  1. <?xml version='1.0' encoding='UTF-8'?><Api responseBodyIsOriginalObject="" authType="AK" responseLog="enable" isolationType="outer" parameterType="Single" product="hitsdb" visibility="Public" akProvenStatus="Disable" version="2017-06-01" keepClientResourceOwnerId="false" name="DescribeHiTSDBInstance" showJsonItemName="false" status="online"><IsvProtocol protocol="HTTPS|HTTP" method="POST|GET" /><ErrorMapping exceptionExpress="success=false,code,message,httpStatusCode"><ErrorCodes><ErrorCode code="TSDB.Errorcode.ParameterInvaild" errorCode="TSDB.Errorcode.ParameterInvaild" type="user" httpCode="400" errorMessage="The parameter is invalid." /><ErrorCode code="TSDB.Errorcode.InstanceCreateRetrying" errorCode="TSDB.Errorcode.InstanceCreateRetrying" type="user" httpCode="415" extendedErrorCode="" errorMessage="The system is trying to create the instance again." /><ErrorCode code="TSDB.Errorcode.InstanceDeleted" errorCode="TSDB.Errorcode.InstanceDeleted" type="user" httpCode="416" extendedErrorCode="" errorMessage="The instance is already deleted." /><ErrorCode code="TSDB.Errorcode.InstanceCreateFailed" errorCode="TSDB.Errorcode.InstanceCreateFailed" type="user" httpCode="414" extendedErrorCode="" errorMessage="Failed to create the instance." /></ErrorCodes></ErrorMapping><IspProtocol interface="com.aliyun.tsdb.phoenix.service.ITSDBService" timeout="10000" protocol="dubbo" invokeType="com.aliyun.tsdb.phoenix.service.request.DescribeHiTSDBInstanceRequest" method="describeHiTSDBInstance" version="1.0.0" retries="-1" /><Parameters><Parameter name="requestId" tagName="RequestId" type="String" required="false" tagPosition="System" checkBlank="false"/><Parameter name="apiName" tagName="Action" type="String" required="false" tagPosition="Query" checkBlank="false" visibility="Public"/><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="Query" checkBlank="false" visibility="Public"/><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="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="clientIP" tagName="app_ip" type="String" required="false" tagPosition="System" checkBlank="false"/><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="regionId" tagName="RegionId" type="String" required="false" tagPosition="Host" checkBlank="false"/><Parameter name="product" tagName="Product" type="String" required="false" tagPosition="System" checkBlank="false" defaultValue="hitsdb"/><Parameter name="category" tagName="Category" type="String" required="false" tagPosition="System" checkBlank="false" defaultValue="instance"/><Parameter name="appKey" tagName="AppKey" type="String" required="false" tagPosition="Query" checkBlank="false" visibility="Public"/><Parameter name="instanceId" tagName="InstanceId" type="String" required="true" tagPosition="Query" docRequired="true" checkBlank="false" visibility="Public"/></Parameters><FlowControl controlUnit="Second" apiDefault="80" /><ResultMapping><Member tagName="RequestId" visibility="Public" type="String" name="requestId"/><Member tagName="InstanceId" visibility="Public" type="String" name="data.instanceId"/><Member tagName="InstanceAlias" visibility="Public" type="String" name="data.instanceAlias"/><Member tagName="InstanceDescription" visibility="Public" type="String" name="data.instanceDescription"/><Member tagName="RegionId" visibility="Public" type="String" name="data.regionId"/><Member tagName="ZoneId" visibility="Public" type="String" name="data.zoneId"/><Member tagName="InstanceStatus" visibility="Public" type="String" name="data.instanceStatus"/><Member tagName="ChargeType" visibility="Public" type="String" name="data.chargeType"/><Member tagName="NetworkType" visibility="Public" type="String" name="data.networkType"/><Member tagName="GmtCreated" visibility="Public" type="String" name="data.gmtCreated"/><Member tagName="GmtExpire" visibility="Public" type="String" name="data.gmtExpire"/><Member tagName="InstanceClass" visibility="Public" type="String" name="data.instanceClass"/><Member tagName="MaxTimelineLimit" visibility="Public" type="String" name="data.maxTimelineLimit"/><Member tagName="InstanceStorage" visibility="Public" type="String" name="data.instanceStorage"/><Member tagName="InstanceTps" visibility="Public" type="String" name="data.instanceTps"/><Member tagName="ReverseVpcIp" visibility="Private" type="String" name="data.reverseVpcIp"/><Member tagName="ReverseVpcPort" visibility="Private" type="String" name="data.reverseVpcPort"/><Member tagName="VpcId" visibility="Public" type="String" name="data.vpcId"/><Member tagName="VswitchId" visibility="Public" type="String" name="data.vswitchId"/><Member tagName="ConnectionString" visibility="Public" type="String" name="data.connectionString"/><Member tagName="PublicConnectionString" visibility="Public" type="String" name="data.publicConnectionString"/><Member tagName="AutoRenew" visibility="Public" type="String" name="data.autoRenew" nullToEmpty="false"/><Member tagName="EngineType" visibility="Public" type="String" name="data.engineType" nullToEmpty="false"/><Member tagName="CpuNumber" visibility="Public" type="String" name="data.cpuNumber" nullToEmpty="true"/><Member tagName="MemSize" visibility="Public" type="String" name="data.memSize" nullToEmpty="true"/><Member tagName="Series" visibility="Public" type="Integer" name="data.series" nullToEmpty="false"/><Member tagName="RDSStatus" visibility="Private" type="String" name="data.rdsStatus" nullToEmpty="true"/><Member tagName="DiskCategory" visibility="Public" type="String" name="data.diskCategory" nullToEmpty="true"/><Member tagName="Status" visibility="Public" type="String" name="data.status" nullToEmpty="false"/><Member tagName="PaymentType" visibility="Public" type="String" name="data.paymentType" nullToEmpty="false"/><Member tagName="CreateTime" visibility="Public" type="Long" name="data.createTime" nullToEmpty="false"/><Member tagName="ExpiredTime" visibility="Public" type="Long" name="data.expiredTime" nullToEmpty="false"/><Array tagName="SecurityIpList" visibility="Public" itemName="SecurityIp" name="data.securityIpList" nullToEmpty="true"><Member tagName="Ip" visibility="Public" type="String" name="ip"/></Array></ResultMapping></Api>