Gunakan DescribeInstanceAutoRenewalAttribute untuk mengkueri atribut auto-renewal instans - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

Mengkueri status pembaruan otomatis instans MongoDB.

Deskripsi operasi

This operation is applicable to subscription instances.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

dds:DescribeInstanceAutoRenewalAttribute

get

Instance

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

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah instans. Anda dapat memanggil operasi DescribeDBInstanceAttribute untuk mengkueri ID wilayah instans.	cn-hangzhou
DBInstanceId	string	No	ID instans.	dds-bp567b****
DBInstanceType	string	No	Kategori instans. Nilai valid: replicate: instans standalone atau replica set. sharding: instans kluster sharded. Nilai default: replicate.	replicate
PageSize	integer	No	Jumlah entri per halaman. Nilai valid: 30, 50, dan 100. Catatan Nilai default: 30.	30
PageNumber	integer	No	Nomor halaman. Nilainya harus berupa bilangan bulat positif yang tidak melebihi nilai maksimum tipe data Integer. Nilai default: 1.	1

Elemen respons

Element	Type	Description	Example
	object
ItemsNumbers	integer	The total number of entries returned.	2
PageRecordCount	integer	The number of entries that were returned on the current page.	2
RequestId	string	The ID of the request.	FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949
PageNumber	integer	The page number of the returned page.	1
Items	object
Item	array<object>	Details about returned entries.
	object
DBInstanceType	string	The category of the instance. Valid values: replicate: the standalone or replica set instance sharding: the sharded cluster instance	replicate
AutoRenew	string	Indicates whether auto-renewal is enabled for the instance. Valid values: true: Auto-renewal is enabled for the instance. false: Auto-renewal is disabled for the instance.	true
Duration	string	The auto-renewal period. Unit: months. Catatan This parameter is ruturned only when the returned value of the AutoRenew parameter is true. You can call the ModifyInstanceAutoRenewalAttribute operation to modify the auto-renewal period.	1
DbInstanceId	string	The ID of the instance.	dds-bp2568*****
RegionId	string	The region ID of the instance.	cn-hangzhou

Contoh

Respons sukses

JSONformat

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

Respons error

JSONformat

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

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	InternalError	The request processing has failed due to some unknown error, exception or failure.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.