すべてのプロダクト
Search

このプロダクト

    ApsaraDB for MongoDB:DescribeInstanceAutoRenewalAttribute

    ドキュメントセンター

    ApsaraDB for MongoDB:DescribeInstanceAutoRenewalAttribute

    最終更新日:Mar 26, 2026

    ApsaraDB for MongoDB インスタンスの自動更新ステータスを照会します。

    操作説明

    この操作はサブスクリプションインスタンスに適用されます。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dds:DescribeInstanceAutoRenewalAttribute

    get

    Instance

    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    インスタンスのリージョン ID。DescribeDBInstanceAttribute 操作を呼び出して、インスタンスのリージョン ID をクエリできます。

    cn-hangzhou
    DBInstanceId

    string

    任意

    インスタンスの ID。

    dds-bp567b****
    DBInstanceType

    string

    任意

    インスタンスのカテゴリ。有効な値：

    • replicate：スタンドアロンインスタンスまたはレプリカセットインスタンス

    • sharding：シャードクラスターインスタンス

    デフォルト値：replicate。

    replicate
    PageSize

    integer

    任意

    各ページに返すエントリ数。有効な値：30、50、100。

    説明

    デフォルト値：30。

    30
    PageNumber

    integer

    任意

    返すページ番号。値は、Integer パラメーターの最大値を超えない正の整数である必要があります。デフォルト値：1。

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    ItemsNumbers

    integer

    返されたエントリの総数。

    2
    PageRecordCount

    integer

    現在のページで返されたエントリ数。

    2
    RequestId

    string

    リクエスト ID。

    FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949
    PageNumber

    integer

    返されたページのページ番号。

    1
    Items

    object

    Item

    array<object>

    返されたエントリの詳細。

    object

    DBInstanceType

    string

    インスタンスのカテゴリ。有効な値：

    • replicate：スタンドアロンインスタンスまたはレプリカセットインスタンス

    • sharding：シャードクラスターインスタンス

    replicate
    AutoRenew

    string

    インスタンスの自動更新が有効になっているかどうかを示します。有効な値：

    • true：インスタンスの自動更新が有効になっています。

    • false：インスタンスの自動更新が無効になっています。

    true
    Duration

    string

    自動更新期間。単位：月。

    説明

    • このパラメーターは、AutoRenew パラメーターの戻り値が true の場合にのみ返されます。

    • ModifyInstanceAutoRenewalAttribute 操作を呼び出して、自動更新期間を変更できます。

    1
    DbInstanceId

    string

    インスタンスの ID。

    dds-bp2568*****
    RegionId

    string

    インスタンスのリージョン ID。

    cn-hangzhou

    例

    成功レスポンス

    JSONJSON

    {
  "ItemsNumbers": 2,
  "PageRecordCount": 2,
  "RequestId": "FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949",
  "PageNumber": 1,
  "Items": {
    "Item": [
      {
        "DBInstanceType": "replicate",
        "AutoRenew": "true",
        "Duration": "1",
        "DbInstanceId": "dds-bp2568*****",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InternalError The request processing has failed due to some unknown error, exception or failure.

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

    変更履歴

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