この API を呼び出して、1 つまたは複数のサブスクリプションインスタンスの自動更新ステータスをクエリできます。

説明

自動更新または手動更新を設定する前に、インスタンスの自動更新ステータスをクエリできます。

この API はサブスクリプションインスタンスにのみサポートされます。 従量課金インスタンスでこの API を呼び出す場合、エラーが返されます。

デバッグ

API Explorer でデバッグを実行できます。 API Explorer で各種操作を実行して API の使用を簡素化できます。 たとえば、API の取得、API の呼び出し、SDK のサンプルコードの動的な生成ができます。

リクエストパラメーター

名前 データ型 必須/省略可能 例 説明
RegionId String 必須 cn-hangzhou

インスタンスのリージョン ID 。 DescribeRegions を実行すると、最新のリージョンリストが表示されます。

Action String 省略可能 DescribeInstanceAutoRenewAttribute

実行する操作。 値を DescribeInstanceAutoRenewAttribute に設定します。

InstanceId String 省略可能 i-instance1,i-instance2

インスタンス ID。 一度に 100 件までのサブスクリプションインスタンス ID を入力できます。 複数のインスタンス ID はコンマ（、）で区切ります。

OwnerAccount String 省略可能 ECSforCloud@Alibaba.com

RAM ユーザーのログインネーム。

PageNumber String 省略可能 1

ページ番号。

この値は 1 から始まります。

既定値 : 1。

PageSize String 省略可能 10

1 ページあたりの行数。

最大値：100。

デフォルト値: 10。

RenewalStatus String 省略可能 AutoRenewal

インスタンスの自動更新ステータス。 有効値：

  • AutoRenewal：自動更新を有効にします。
  • Normal：自動更新を無効にします。
  • NotRenewa：更新を使用しません。 システムは有効期限リマインダーを送信しなくなりましたが、有効期限の 3 日前に非更新リマインダーのみを送信します。 更新が使用されないインスタンスの場合、ModifyInstanceAutoRenewAttribute API を呼び出して、自動更新ステータスをNormalに変更できます。 そして、手動更新か、自動更新に設定できます。

レスポンスパラメーター

名前 データ型 例 説明
InstanceRenewAttributes

更新属性セット。

└AutoRenewEnabled Boolean false

自動更新が有効になっているかどうかを示します。

└Duration Integer 1

自動更新期間。

└InstanceId String i-instanceid1

インスタンス ID。

└PeriodUnit String week

自動更新期間の単位。

└RenewalStatus String Normal

インスタンスの自動更新ステータス。 有効値：

  • AutoRenewal：自動更新を有効にします。
  • Normal：自動更新を無効にします。
  • NotRenewa：更新を使用しません。 システムは有効期限リマインダーを送信しなくなりましたが、有効期限の 3 日前に非更新リマインダーのみを送信します。 更新が使用されないインスタンスの場合、ModifyInstanceAutoRenewAttribute API を呼び出して、自動更新ステータスをNormalに変更できます。 そして、手動更新か、自動更新に設定できます。
PageNumber Integer 1

ページ番号。

この値は 1 から始まります。

既定値 : 1。

PageSize Integer 10

1 ページあたりの行数。

最大値：100。

デフォルト値: 10。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

リクエスト ID 。 API 操作が成功したかどうかにかかわらず、システムは各 API リクエストに対して一意の RequestId を返します。

TotalCount Integer 6

インスタンスの総数。

例

リクエストの例


https://ecs.aliyuncs.com/?Action=DescribeInstanceAutoRenewAttribute
&RegionId=cn-hangzhou 
&InstanceId=i-instance1,i-instance2 
&PageNumber=1 
&PageSize=10 
&RenewalStatus=AutoRenewal
&<Common request parameters>

通常のレスポンスの例

XML 形式 

<DescribeInstanceAutoRenewAttributeResponse>
  <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId> 
  <InstanceRenewAttributes>
    <InstanceRenewAttribute>
      <Instance> 
        <InstanceId>i-instance1</InstanceId>
        <Duration>0</Duration> 
        <AutoRenewEnalbed>false</AutoRenewEnalbed> 
        <RenewalStatus>Normal</RenewalStatus>
      </Instance> 
      <Instance> 
        <InstanceId>i-instance2</InstanceId>
        <Duration>1</Duration> 
        <AutoRenewEnalbed>true</AutoRenewEnalbed> 
        <RenewalStatus>AutoRenewal</RenewalStatus> 
      </Instance> 
    </InstanceRenewAttribute>
  </InstanceRenewAttributes>
</DescribeInstanceAutoRenewAttributeResponse>

JSON 形式 

{
	"InstanceRenewAttributes":{
		"InstanceRenewAttribute":[
			{
				"RenewalStatus":"Normal",
				"InstanceId":"i-instance1",
				"Duration":0,
				"AutoRenewEnabled":false
			},
			{
				"RenewalStatus":"AutoRenewal",
				"InstanceId":"i-instance2",
				"Duration":1,
				"AutoRenewEnabled":true
			}
		]
	},
	"RequestId":"04F0F334-1335-436C-A1D7-6C044FE73368"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
403 MissingParameter.InstanceId InstanceId should not be null. InstanceId が指定されていない場合に返されるエラーメッセージ。
403 InvalidParameter.InvalidInstanceId %s InstanceId が無効な場合に返されるエラーメッセージ。
403 IncorrectInstanceStatus The current status of the resource does not support this operation. リソースの現在のステータスで該当の操作がサポートされていない場合に返されるエラーメッセージ。
403 InvalidParameter.RenewalStatus The specified parameter RenewalStatus is not valid. 指定された RenewalStatus が無効な場合に返されるエラーメッセージ。
403 InvalidParameter.RenewalStatusInstanceId The parameter RenewalStatus and InstanceId cannot be both empty. RenewalStatus と InstanceId の両方が指定されていない場合に返されるエラーメッセージ。

エラーコードの表示