すべてのプロダクト
Search

このプロダクト

    Elastic Compute Service:DescribeInstanceAutoRenewAttribute

    ドキュメントセンター

    Elastic Compute Service:DescribeInstanceAutoRenewAttribute

    最終更新日:Apr 04, 2026

    この API は、1 つ以上のサブスクリプション Elastic Compute Service (ECS) インスタンスの自動更新ステータスと更新期間を返します。

    操作説明

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

    • インスタンスの自動更新または手動更新を設定する前に、更新ステータスをクエリして、自動更新がすでに有効になっているかどうかを確認してください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ecs:DescribeInstanceAutoRenewAttribute

    list

    Instance

    acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

    Instance

    acs:ecs:{#regionId}:{#accountId}:instance/*

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    任意

    インスタンス ID。 一度に最大 100 個のサブスクリプションインスタンスを指定できます。 複数のインスタンス ID はコンマで区切ります。

    説明

    InstanceId または RenewalStatus のいずれかを指定する必要があります。

    i-bp18x3z4hc7bixhx****,i-bp1g6zv0ce8oghu7****
    RegionId

    string

    必須

    リージョン ID。 DescribeRegions を呼び出して、Alibaba Cloud リージョンの最新リストを表示できます。

    cn-hangzhou
    RenewalStatus

    string

    任意

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

    • AutoRenewal：自動更新が有効になっています。

    • Normal：自動更新が無効になっています。

    • NotRenewal：インスタンスは更新されません。 システムは有効期限の通知を送信しませんが、有効期限が切れる 3 日前に更新されない旨の通知を送信します。 このステータスの ECS インスタンスを更新するには、まず ModifyInstanceAutoRenewAttribute を呼び出してステータスを Normal に変更する必要があります。 その後、インスタンスを手動で更新するか、自動更新を有効にすることができます。

    AutoRenewal
    PageSize

    string

    任意

    ページあたりのエントリ数。

    最大値：100。

    デフォルト値：10。

    10
    PageNumber

    string

    任意

    返すページ番号。

    最小値：1。

    デフォルト値：1。

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスボディ。

    RequestId

    string

    リクエスト ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    PageNumber

    integer

    ページ番号。

    1
    PageSize

    integer

    ページあたりのエントリ数。

    10
    TotalCount

    integer

    返されるインスタンスの総数。

    6
    InstanceRenewAttributes

    object

    インスタンスの自動更新属性。

    InstanceRenewAttribute

    array<object>

    InstanceRenewAttribute オブジェクトの配列。

    object

    PeriodUnit

    string

    自動更新期間の単位。

    week
    Duration

    integer

    自動更新期間。

    1
    RenewalStatus

    string

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

    • AutoRenewal：インスタンスは自動更新されるように設定されています。

    • Normal：自動更新が無効になっています。 インスタンスを手動で更新するか、自動更新を有効にすることができます。

    • NotRenewal：インスタンスは更新されません。 システムは有効期限の通知を送信しませんが、有効期限が切れる 3 日前に更新されない旨の通知を送信します。 このステータスの ECS インスタンスの更新を有効にするには、まず ModifyInstanceAutoRenewAttribute を呼び出してステータスを Normal に変更する必要があります。 その後、インスタンスを手動で更新するか、自動更新を有効にすることができます。

    Normal
    InstanceId

    string

    インスタンス ID。

    i-bp18x3z4hc7bixhx****
    AutoRenewEnabled

    boolean

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

    false
    EnableExpectedRenewDay

    boolean

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 6,
  "InstanceRenewAttributes": {
    "InstanceRenewAttribute": [
      {
        "PeriodUnit": "week",
        "Duration": 1,
        "RenewalStatus": "Normal",
        "InstanceId": "i-bp18x3z4hc7bixhx****",
        "AutoRenewEnabled": false,
        "EnableExpectedRenewDay": false
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Throttling Request was denied due to request throttling.
    403 MissingParameter.InstanceId InstanceId should not be null.
    403 InvalidParameter.ToManyInstanceIds InstanceId should be less than 100.
    403 IncorrectInstanceStatus The current status of the resource does not support this operation.
    403 ChargeTypeViolation Pay-As-You-Go instances do not support this operation.
    403 InvalidParameter.RenewalStatus The specified parameter RenewalStatus is not valid.
    403 InvalidParameter.RenewalStatusInstanceId The parameter RenewalStatus and InstanceId can not be both empty.
    403 InvalidParameter.PageSize The specified parameter PageSize is not valid.
    403 InvalidParameter.PageNumber The specified parameter PageNumber is not valid.
    403 InvalidParameter.InvalidInstanceId The specified InstanceId does not exist.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。