Reports interface
表示報表的介面。
方法
方法詳細資料
listByApi(string, string, string, ReportsListByApiOptionalParams)
列出依 API 的報表記錄。
function listByApi(resourceGroupName: string, serviceName: string, filter: string, options?: ReportsListByApiOptionalParams): PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- filter
-
string
要套用至作業的篩選條件。
- options
- ReportsListByApiOptionalParams
選項參數。
傳回
listByGeo(string, string, string, ReportsListByGeoOptionalParams)
依地理位置列出報表記錄。
function listByGeo(resourceGroupName: string, serviceName: string, filter: string, options?: ReportsListByGeoOptionalParams): PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- filter
-
string
|欄位 |使用量 |支持的運算子 |支援的函式 |
|-------------|-------------|-------------|-------------|
|timestamp |filter |ge, le | |
|國家/地區 |select | | | |
|region |select | | | |
|zip |select | | | |
|apiRegion |filter |eq | |
|userId |filter |eq | |
|productId |filter |eq | |
|subscriptionId |filter |eq | |
|apiId |filter |eq | |
|operationId |filter |eq | |
|callCountSuccess |select | | | |
|callCountBlocked |select | | | |
|callCountFailed |select | | | |
|callCountOther |select | | | |
|bandwidth |select,orderBy | | |
|cacheHitsCount |select | | | |
|cacheMissCount |select | | | |
|apiTimeAvg |select | | | |
|apiTimeMin |select | | | |
|apiTimeMax |select | | | |
|serviceTimeAvg |select | | | |
|serviceTimeMin |select | | | |
|serviceTimeMax |select | | | |
- options
- ReportsListByGeoOptionalParams
選項參數。
傳回
listByOperation(string, string, string, ReportsListByOperationOptionalParams)
依 API 作業列出報表記錄。
function listByOperation(resourceGroupName: string, serviceName: string, filter: string, options?: ReportsListByOperationOptionalParams): PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- filter
-
string
|欄位 |使用量 |支持的運算子 |支援的函式 |
|-------------|-------------|-------------|-------------|
|timestamp |filter |ge, le | |
|displayName |select,orderBy | | |
|apiRegion |filter |eq | |
|userId |filter |eq | |
|productId |filter |eq | |
|subscriptionId |filter |eq | |
|apiId |filter |eq | |
|operationId |select, filter |eq | |
|callCountSuccess |select,orderBy | | |
|callCountBlocked |select,orderBy | | |
|callCountFailed |select,orderBy | | |
|callCountOther |select,orderBy | | |
|callCountTotal |select,orderBy | | |
|bandwidth |select,orderBy | | |
|cacheHitsCount |select | | | |
|cacheMissCount |select | | | |
|apiTimeAvg |select,orderBy | | |
|apiTimeMin |select | | | |
|apiTimeMax |select | | | |
|serviceTimeAvg |select | | | |
|serviceTimeMin |select | | | |
|serviceTimeMax |select | | | |
選項參數。
傳回
listByProduct(string, string, string, ReportsListByProductOptionalParams)
依 Product 列出報表記錄。
function listByProduct(resourceGroupName: string, serviceName: string, filter: string, options?: ReportsListByProductOptionalParams): PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- filter
-
string
|欄位 |使用量 |支持的運算子 |支援的函式 |
|-------------|-------------|-------------|-------------|
|timestamp |filter |ge, le | |
|displayName |select,orderBy | | |
|apiRegion |filter |eq | |
|userId |filter |eq | |
|productId |select, filter |eq | |
|subscriptionId |filter |eq | |
|callCountSuccess |select,orderBy | | |
|callCountBlocked |select,orderBy | | |
|callCountFailed |select,orderBy | | |
|callCountOther |select,orderBy | | |
|callCountTotal |select,orderBy | | |
|bandwidth |select,orderBy | | |
|cacheHitsCount |select | | | |
|cacheMissCount |select | | | |
|apiTimeAvg |select,orderBy | | |
|apiTimeMin |select | | | |
|apiTimeMax |select | | | |
|serviceTimeAvg |select | | | |
|serviceTimeMin |select | | | |
|serviceTimeMax |select | | | |
選項參數。
傳回
listByRequest(string, string, string, ReportsListByRequestOptionalParams)
依要求列出報表記錄。
function listByRequest(resourceGroupName: string, serviceName: string, filter: string, options?: ReportsListByRequestOptionalParams): PagedAsyncIterableIterator<RequestReportRecordContract, RequestReportRecordContract[], PageSettings>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- filter
-
string
|欄位 |使用量 |支持的運算子 |支援的函式 |
|-------------|-------------|-------------|-------------|
|timestamp |filter |ge, le | |
|apiId |filter |eq | |
|operationId |filter |eq | |
|productId |filter |eq | |
|userId |filter |eq | |
|apiRegion |filter |eq | |
|subscriptionId |filter |eq | |
選項參數。
傳回
listBySubscription(string, string, string, ReportsListBySubscriptionOptionalParams)
依訂用帳戶列出報表記錄。
function listBySubscription(resourceGroupName: string, serviceName: string, filter: string, options?: ReportsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- filter
-
string
|欄位 |使用量 |支持的運算子 |支援的函式 |
|-------------|-------------|-------------|-------------|
|timestamp |filter |ge, le | |
|displayName |select,orderBy | | |
|apiRegion |filter |eq | |
|userId |select, filter |eq | |
|productId |select, filter |eq | |
|subscriptionId |select, filter |eq | |
|callCountSuccess |select,orderBy | | |
|callCountBlocked |select,orderBy | | |
|callCountFailed |select,orderBy | | |
|callCountOther |select,orderBy | | |
|callCountTotal |select,orderBy | | |
|bandwidth |select,orderBy | | |
|cacheHitsCount |select | | | |
|cacheMissCount |select | | | |
|apiTimeAvg |select,orderBy | | |
|apiTimeMin |select | | | |
|apiTimeMax |select | | | |
|serviceTimeAvg |select | | | |
|serviceTimeMin |select | | | |
|serviceTimeMax |select | | | |
選項參數。
傳回
listByTime(string, string, string, string, ReportsListByTimeOptionalParams)
依時間列出報表記錄。
function listByTime(resourceGroupName: string, serviceName: string, filter: string, interval: string, options?: ReportsListByTimeOptionalParams): PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- filter
-
string
|欄位 |使用量 |支持的運算子 |支援的函式 |
|-------------|-------------|-------------|-------------|
|timestamp |篩選,選取 |ge, le | |
|interval |select | | | |
|apiRegion |filter |eq | |
|userId |filter |eq | |
|productId |filter |eq | |
|subscriptionId |filter |eq | |
|apiId |filter |eq | |
|operationId |filter |eq | |
|callCountSuccess |select | | | |
|callCountBlocked |select | | | |
|callCountFailed |select | | | |
|callCountOther |select | | | |
|bandwidth |select,orderBy | | |
|cacheHitsCount |select | | | |
|cacheMissCount |select | | | |
|apiTimeAvg |select | | | |
|apiTimeMin |select | | | |
|apiTimeMax |select | | | |
|serviceTimeAvg |select | | | |
|serviceTimeMin |select | | | |
|serviceTimeMax |select | | | |
- interval
-
string
依時間間隔。 間隔必須是15分鐘的倍數,而且可能不是零。 此值應為 ISO 8601 格式 (http://en.wikipedia.org/wiki/ISO_8601#Durations)。此程式代碼可用來將 TimeSpan 轉換為有效的間隔字串:XmlConvert.ToString(新的 TimeSpan(小時、分鐘、秒))。
- options
- ReportsListByTimeOptionalParams
選項參數。
傳回
listByUser(string, string, string, ReportsListByUserOptionalParams)
依使用者列出報表記錄。
function listByUser(resourceGroupName: string, serviceName: string, filter: string, options?: ReportsListByUserOptionalParams): PagedAsyncIterableIterator<ReportRecordContract, ReportRecordContract[], PageSettings>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- filter
-
string
|欄位 |使用量 |支持的運算子 |支援的函式 |
|-------------|-------------|-------------|-------------|
|timestamp |filter |ge, le | |
|displayName |select,orderBy | | |
|userId |select, filter |eq | |
|apiRegion |filter |eq | |
|productId |filter |eq | |
|subscriptionId |filter |eq | |
|apiId |filter |eq | |
|operationId |filter |eq | |
|callCountSuccess |select,orderBy | | |
|callCountBlocked |select,orderBy | | |
|callCountFailed |select,orderBy | | |
|callCountOther |select,orderBy | | |
|callCountTotal |select,orderBy | | |
|bandwidth |select,orderBy | | |
|cacheHitsCount |select | | | |
|cacheMissCount |select | | | |
|apiTimeAvg |select,orderBy | | |
|apiTimeMin |select | | | |
|apiTimeMax |select | | | |
|serviceTimeAvg |select | | | |
|serviceTimeMin |select | | | |
|serviceTimeMax |select | | | |
- options
- ReportsListByUserOptionalParams
選項參數。