匯出 (0) 列印
全部展開

列出訂閱作業

更新日期: 2014年5月

List Subscription Operations 作業會傳回訂閱在指定的時間範圍內執行的建立、更新和刪除作業的清單。

請使用下列格式指定 List Subscription Operations 要求。以訂用帳戶識別碼取代 <subscription-id>

 

方法 要求 URI

GET

https://management.core.windows.net/<subscription-id>/operations

您必須確定對管理服務發出的要求是安全的。如需其他詳細資訊,請參閱驗證服務管理要求

 

URI 參數 描述

StartTime=<start-of-timeframe>

必要項。要開始列出訂閱作業的時間範圍起始值,以 UTC 格式表示。此參數與 EndTime 參數指出要擷取訂閱作業的時間範圍。此參數所指的開始日期不得早於過去 90 天。

如果以此參數指定時間,則必須在時間前面附上常值字串 "T" 表示時間元素的開頭。另外,時間元素後面也必須附上常值字串 "Z" 表示時間為 UTC 格式。例如,開始時間為 2011 年 3 月 1 日下午 4:30 的表示法如下:StartTime=2011-03-01T16:30:00Z

您可以使用下列時間格式:

  • StartTime=[4DigitYear]-[2DigitMonth]-[2DigitDay]

    範例:StartTime=2011-03-01

  • StartTime=[4DigitYear]-[2DigitMonth]-[2DigitDay]T[2DigitHour]:[2DigitMinute]:2DigitSecond]Z

    範例:StartTime=2011-03-01T16:30:00Z

  • StartTime=[4DigitYear]-[2DigitMonth]-[2DigitDay]T[2DigitMinute]:[2DigitSecond].[7DigitsOfPrecision]Z

    範例:StartTime=2011-03-01T16:30:00.0005000Z

EndTime=<end-of-timeframe>

必要項。要開始列出訂閱作業的時間範圍結束值,以 UTC 格式表示。此參數與 StartTime 參數指出要擷取訂閱作業的時間範圍。

如果以此參數指定時間,則必須在時間前面附上常值字串 "T" 表示時間元素的開頭。另外,時間元素後面也必須附上常值字串 "Z" 表示時間為 UTC 格式。例如,結束時間為 2011 年 3 月 7 日下午 4:30 的表示法如下:EndTime=2011-03-07T16:30:00Z

您可以使用下列時間格式:

  • EndTime=[4DigitYear]-[2DigitMonth]-[2DigitDay]

    範例:EndTime=2011-03-07

  • EndTime=[4DigitYear]-[2DigitMonth]-[2DigitDay]T[2DigitHour]:[2DigitMinute]:2DigitSecond]Z

    範例:EndTime=2011-03-07T16:30:00Z

  • EndTime=[4DigitYear]-[2DigitMonth]-[2DigitDay]T[2DigitMinute]:[2DigitSecond].[7DigitsOfPrecision]Z

    範例:EndTime=2011-03-07T16:30:00.0005000Z

ObjectIdFilter=<object-url>

選擇性。只針對指定的物件類型和物件識別碼傳回訂閱作業。此參數必須設定成等於對物件執行 HTTP GET 時的 URL 值。如果未指定物件,便不會套用篩選。適用的物件類型及範例附於下表。請以您自己的值取代 <subscription-id> 等範例值。

 

物件類型

篩選器的物件 URL

訂用帳戶

ObjectIdFilter=/<subscription-id>

雲端服務

ObjectIdFilter=/<subscription-id>/services/hostedservices/<cloud-service-name>

儲存體服務

ObjectIdFilter=/<subscription-id>/services/storageservices/<storage-service-name>

同質群組

ObjectIdFilter=/<subscription-id>/affinitygroups/<affinity-group-name>

部署

ObjectIdFilter=/<subscription-id>/services/hostedservices/<cloud-service-name>/deployments/<deployment-name>

角色執行個體

ObjectIdFilter=/<subscription-id>/services/hostedservices/<cloud-service-name>/deployments/<deployment-name>/roleinstances/<role-instance-name>

機器映像

ObjectIdFilter=/<subscription-id>/machineimages/<machine-image-name>

OperationResultFilter=<Succeeded|Failed|InProgress>

選擇性。只針對指定的結果狀態 (如 SucceededFailedInProgress) 傳回訂閱作業。此篩選可與 ObjectIdFilter 併用,以選取具特定結果狀態之物件的訂閱作業。如果未指定結果狀態,便不會套用篩選。例如,下列要求 URI 片段會傳回儲存體服務的所有成功作業:

ObjectIdFilter=/<subscription-id>/services/storageservices/<storage-service-name>&OperationResultFilter=Succeeded

ContinuationToken=<opaque-continuation-token>

選擇性。如果有太多作業需要列出,例如因要求的時間範圍極廣,回應就會包括一份不完整的清單,以及可用來傳回清單其餘部分的 Token。後續的要求必須附上此參數,以便繼續列出前次回應仍未傳回的作業。如果未指定 Token,便不會套用篩選,而且回應將以指定的 StartTime 為起始點。

下表描述要求標頭。

 

要求標頭 描述

x-ms-version

必要項。指定用於這個要求的作業版本。此標頭應該設定為 2011/2/25 或更高版本。如需版本設定標頭的詳細資訊,請參閱服務管理版本設定

無。

回應包括 HTTP 狀態碼、一組回應標頭和回應主體。

成功的作業會傳回狀態碼 200 (確定)。如需狀態碼的資訊,請參閱<服務管理狀態和錯誤碼>。

這項作業的回應包括下列標頭。回應也可能包括其他標準 HTTP 標頭。所有標準標頭都符合 HTTP/1.1 通訊協定規格

 

回應標頭 描述

x-ms-request-id

唯一識別對管理服務發出之要求的值。

回應主體的格式如下:


<?xml version="1.0" encoding="utf-8"?>
<SubscriptionOperationCollection xmlns="http://schemas.microsoft.com/windowsazure" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <SubscriptionOperations>
    <SubscriptionOperation>
      <OperationId>subscription-operation-id</OperationId>
      <OperationObjectId>subscription-object-id</OperationObjectId>
      <OperationName>subscription-operation-name</OperationName>
      <OperationParameters xmlns:a="http://schemas.datacontract.org/2004/07/Microsoft.Samples.WindowsAzure.ServiceManagement">
        <OperationParameter>
          <a:Name>operation-parameter-name</a:Name>
          <a:Value><?xml version="1.0" encoding="utf-16"?>
            <z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:d1p1="http://schemas.microsoft.com/windowsazure" i:type="d1p1:<type-body>" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
              …xml body…
            </z:anyType>
          </a:Value>
        </OperationParameter>
      </OperationParameters>
      <OperationCaller>
        <UsedServiceManagementApi>true</UsedServiceManagementApi>
        <SubscriptionCertificateThumbprint>subscription-certificate-thumbprint</SubscriptionCertificateThumbprint>
        <ClientIP>client-ip-address</ClientIP>
      </OperationCaller>
      <OperationStatus>operation-status</OperationStatus>
      <OperationStartedTime>operation-start-time</OperationStartedTime>
      <OperationCompletedTime>operation-completed-time</OperationCompletedTime>
    </SubscriptionOperation>
  </SubscriptionOperations>
<ContinuationToken>continuation-token-value</ContinuationToken>
</SubscriptionOperationCollection>

下表描述回應主體中的元素。

 

元素名稱 描述

訂閱作業

指定訂閱在指定的時間範圍內已執行之作業的清單。

接續 Token

指定可用來傳回清單其餘部分的字串。後續的要求必須附上此參數,以便繼續列出前次回應仍未傳回的作業。此元素只限於未傳回訂閱作業的完整清單時才會出現。

訂閱作業

指定訂閱在指定的時間範圍內已執行的單項作業。

作業識別碼

指定作業的全域唯一識別碼 (GUID)。

作業物件識別碼

指定作業的目標物件。這個值等於對物件執行 HTTP GET 時的 URL,而且對應到要求中相同的 ObjectIdFilter 值。

作業名稱

指定執行之作業的名稱。可能的值為:

  • ActivateDomainName

  • AddCertificates

  • AddSubscriptionCertificate

  • ChangeDeploymentConfiguration

  • ChangeDeploymentConfigurationBySlot

  • CommitImageUpload

  • CreateAffinityGroup

  • CreateDeployment

  • CreateDeploymentBySlot

  • CreateHostedService

  • CreateStorageService

  • DeleteAffinityGroup

  • DeleteCertificate

  • DeleteDeployment

  • DeleteHostedService

  • DeleteImage

  • DeleteStorageService

  • PrepareImageUpload

  • RebootDeploymentRoleInstance

  • RebootDeploymentRoleInstanceBySlot

  • ReimageDeploymentRoleInstance

  • ReimageDeploymentRoleInstanceBySlot

  • RegenerateStorageServiceKeys

  • RegisterDomainName

  • RemoveSubscriptionCertificate

  • RollbackDeploymentUpdateOrUpgrade

  • SetImageProperties

  • SetParentImage

  • SwapDeployment

  • UnregisterDomainName

  • UpdateAffinityGroup

  • UpdateDeploymentStatus

  • UpdateDeploymentStatusBySlot

  • UpdateHostedService

  • UpdateStorageService

  • UpdateStorageService

  • UpgradeDeployment

  • UpgradeDeploymentBySlot

  • WalkUpgradeDomain

  • WalkUpgradeDomainBySlot

作業參數

指定所執行作業的參數集合。

作業參數

指定所執行作業的單一參數。

名稱

指定參數的名稱。

指定參數的值。這個值可能表示成字串或 XML 文件,視執行的訂閱作業而定。

OperationCaller

指定識別作業來源的屬性集合。

UsedServiceManagementApi

指出作業是否透過使用服務管理 API 所起始。False 則表示作業是由其他來源起始,例如管理入口網站。

UserEmailAddress

指定與經由管理入口網站起始作業的使用者其 Windows Live ID 相關聯的電子郵件。此元素只限於 UsedServiceManagementApifalse 時才會傳回。

ClientIP

指定起始作業的用戶端電腦其 IP 位址。此元素只限於 UsedServiceManagementApitrue 時才會傳回。

SubscriptionCertificateThumbprint

指定用以起始作業之訂閱憑證的憑證指紋。

作業狀態

指定包含作業目前狀態相關資訊的物件。傳回的物件具有下列 XML 格式:

<OperationStatus><ID>339c6c13-1f81-412f-9bc6-00e9c5876695</ID><Status>Succeeded</Status><HttpStatusCode>200</HttpStatusCode></OperationStatus>

Status 元素將指出作業狀態,可能的值包括:

  • Succeeded

  • Failed

  • InProgress

OperationStartedTime

指定作業開始執行的時間。時間的格式如下:

[4DigitYear]-[2DigitMonth]-[2DigitDay]T[2DigitHour]:[2DigitMinute]:2DigitSecond]Z

範例:2011-05-11T16:15:26Z

note附註
指定 OperationStartedTime 元素僅限於使用 2011-06-01 版或更新版本時才能使用。

OperationCompletedTime

指定作業執行完成的時間。如果作業仍在進行中,此元素便不存在。時間的格式如下:

[4DigitYear]-[2DigitMonth]-[2DigitDay]T[2DigitHour]:[2DigitMinute]:2DigitSecond]Z

範例:2011-05-11T16:15:32Z

note附註
OperationCompletedTime 元素僅限於使用 2011-06-01 版或更新版本時才能使用。

顯示:
© 2014 Microsoft