調用QueryAvailableInstances查詢用戶已開通實例的列表。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
Action | String | 是 | QueryAvailableInstances | 要執行的操作。取值:QueryAvailableInstances。 |
Region | String | 否 | cn-hangzhou | 設置需要查詢的地域。取值:
|
PageNum | Integer | 否 | 1 | 分頁查詢時,顯示當前頁的頁碼。 |
PageSize | Integer | 否 | 20 | 分頁查詢時,顯示的每頁數據的最大條數。 |
ProductCode | String | 否 | dbaudit | 產品代碼。 數據庫審計產品代碼為dbaudit。 說明 當設置了Region時,該項不能為空。 |
ProductType | String | 否 | 為空 | 產品類型。該參數無需填寫。 |
SubscriptionType | String | 否 | Subscription | 付費類型。 數據庫審計需設置為Subscription,表示預付費類型。 |
InstanceIDs | String | 否 | dbaudit-cn-**** | 實例ID。多個ID用英文逗號分隔,最大不超過100個。 |
EndTimeStart | String | 否 | 2020-05-23T12:00:00Z | 實例到期時間的起始時間,符合ISO 8601標準的UTC時間格式,例如2020-05-23T12:00:00Z。 |
EndTimeEnd | String | 否 | 2020-05-23T12:00:00Z | 實例到期時間的結束時間,符合ISO 8601標準的UTC時間格式,例如2020-05-23T12:00:00Z。 |
CreateTimeStart | String | 否 | 2020-05-23T12:00:00Z | 開通實例的起始時間,符合ISO 8601標準的UTC時間格式。 |
CreateTimeEnd | String | 否 | 2020-05-23T12:00:00Z | 開通實例的結束時間,符合ISO 8601標準的UTC時間格式。 |
RenewStatus | String | 否 | ManualRenewal | 續費狀態,取值:
|
返回數據
名稱 | 類型 | 示例值 | 描述 |
Code | String | Success | 本次請求的狀態碼。 |
Data | Struct | 本次請求的返回信息。 | |
InstanceList | Array | 實例信息的列表。 | |
CreateTime | String | 2023-02-06T08:19:47Z | 實例的創建時間。 |
EndTime | String | 2025-09-15T16:00:00Z | 實例的結束時間。 |
InstanceID | String | dbaudit-cn-**** | 數據庫審計實例的ID。 |
OwnerId | Long | 181**** | 實例所屬的阿里云賬號ID。 |
ProductCode | String | dbaudit | 產品代碼。 |
ProductType | String | dbaudit | 產品類型。 |
Region | String | cn-hangzhou | 實例的地域。 |
ReleaseTime | String | 2020-11-07T16:00:00Z | 實例的釋放時間。 |
RenewStatus | String | ManualRenewal | 續費狀態,取值:
|
RenewalDuration | Integer | 1 | 自動續費周期數量。 |
RenewalDurationUnit | String | M | 自動續費周期單位,取值:
|
Seller | String | 26888 | 銷售實例的賣方,可以是阿里云及其合作伙伴。 |
SellerId | Long | 123123123 | 銷售實例的賣方ID。 |
Status | String | Creating | 實例的狀態。 |
StopTime | String | 2020-11-07T16:00:00Z | 實例的停止時間。 |
SubStatus | String | Normal | 實例的子狀態。 |
SubscriptionType | String | Subscription | 實例的付費類型,固定取值為Subscription,表示預付費。 |
PageNum | Integer | 1 | 分頁查詢時,顯示當前頁的頁碼。 |
PageSize | Integer | 10 | 分頁查詢時,顯示的每頁數據的最大條數。 |
TotalCount | Integer | 11 | 實例列表的總記錄數。 |
Message | String | Successful! | Code對應的狀態碼信息。 |
RequestId | String | C7C15585-8349-4C62-BEE4-5A391841B9BE | 本次調用請求的ID,是由阿里云為該請求生成的唯一標識符,可用于排查和定位問題。 |
Success | Boolean | true | 本次請求是否成功。取值:
|
示例
請求示例
http(s)://[Endpoint]/?Action=QueryAvailableInstances
&<公共請求參數>
正常返回示例
XML
格式
<QueryAvailableInstancesResponse>
<Data>
<TotalCount>51</TotalCount>
<PageSize>20</PageSize>
<PageNum>1</PageNum>
<InstanceList>
<Status>Creating</Status>
<SubStatus>Normal</SubStatus>
<SubscriptionType>Subscription</SubscriptionType>
<RenewStatus>ManualRenewal</RenewStatus>
<InstanceID>dbaudit-cn-****</InstanceID>
<ProductCode>dbaudit</ProductCode>
<CreateTime>2020-09-08T16:00:00Z</CreateTime>
<OwnerId>181****</OwnerId>
<EndTime>2020-11-07T16:00:00Z</EndTime>
<Seller>26888</Seller>
</InstanceList>
<InstanceList>
<Status>Creating</Status>
<SubStatus>Normal</SubStatus>
<SubscriptionType>Subscription</SubscriptionType>
<RenewStatus>ManualRenewal</RenewStatus>
<InstanceID>dbaudit-cn-****</InstanceID>
<ProductCode>dbaudit</ProductCode>
<CreateTime>2020-09-08T16:00:00Z</CreateTime>
<OwnerId>181****</OwnerId>
<EndTime>2020-11-07T16:00:00Z</EndTime>
<Seller>26888</Seller>
</InstanceList>
</Data>
<Message>Successful!</Message>
<RequestId>C7C15585-8349-4C62-BEE4-5A391841B9BE</RequestId>
<Success>true</Success>
<Code>Success</Code>
</QueryAvailableInstancesResponse>
JSON
格式
{
"Data": {
"TotalCount": 51,
"PageSize": 20,
"PageNum": 1,
"InstanceList": [
{
"Status": "Creating",
"SubStatus": "Normal",
"SubscriptionType": "Subscription",
"RenewStatus": "ManualRenewal",
"InstanceID": "dbaudit-cn-****",
"ProductCode": "dbaudit",
"CreateTime": "2020-09-08T16:00:00Z",
"OwnerId": "181****",
"EndTime": "2020-11-07T16:00:00Z",
"Seller": 26888
},
{
"Status": "Creating",
"SubStatus": "Normal",
"SubscriptionType": "Subscription",
"RenewStatus": "ManualRenewal",
"InstanceID": "dbaudit-cn-****",
"ProductCode": "dbaudit",
"CreateTime": "2020-09-08T16:00:00Z",
"OwnerId": "181****",
"EndTime": "2020-11-07T16:00:00Z",
"Seller": 26888
}
]
},
"Message": "Successful!",
"RequestId": "C7C15585-8349-4C62-BEE4-5A391841B9BE",
"Success": true,
"Code": "Success"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。