全部產品
Search

搜尋本產品

    ApsaraDB for MongoDB：DescribeInstanceAutoRenewalAttribute - 查詢MongoDB執行個體是否為自動付費

    文件中心

    ApsaraDB for MongoDB：DescribeInstanceAutoRenewalAttribute - 查詢MongoDB執行個體是否為自動付費

    更新時間：Apr 21, 2026

    查詢MongoDB執行個體是否為自動付費。

    介面說明

    說明

    本介面適用於訂用帳戶付費類型的執行個體。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dds:DescribeInstanceAutoRenewalAttribute

    get

    Instance

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    是

    執行個體所屬的地區 ID。您可以通過調用 DescribeDBInstanceAttribute 介面查詢。

    cn-hangzhou
    DBInstanceId

    string

    否

    執行個體 ID。

    dds-bp567b****
    DBInstanceType

    string

    否

    執行個體類型。取值：

    • replicate（預設值）：單節點或複本集執行個體。

    • sharding：分區叢集執行個體。

    replicate
    PageSize

    integer

    否

    每頁記錄數。取值：30（預設值）、50 或 100。

    30
    PageNumber

    integer

    否

    頁碼，取值為大於 0 且不超過 整數資料類型的最大值，預設值為 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

    自動續約的續約周期，單位為月。

    說明

    1
    DbInstanceId

    string

    執行個體 ID。

    dds-bp2568*****
    RegionId

    string

    地區 ID。

    cn-hangzhou

    樣本

    正常返回樣本

    JSON格式

    {
  "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"
      }
    ]
  }
}

    異常返回樣本

    JSON格式

    {
 "Items": {
   "Item": [
     {
       "Duration": 1,
       "RegionId": "cn-shanghai",
       "DBInstanceId": "r-xxxxxxxxxxxxxxx",
       "AutoRenew": "true"
     }
   ]
 },
 "TotalRecordCount": 1,
 "PageNumber": 1,
 "RequestId": "2B17D708-1D6D-49F3-B6D7-478371DDDBE8",
 "PageRecordCount": 1
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InternalError The request processing has failed due to some unknown error, exception or failure. 內部錯誤，請稍後重試。

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。