ApsaraDB for MongoDB:DescribeDBInstancePerformance-ApsaraDB for MongoDB-Alibaba Cloud - ApsaraDB for MongoDB

Membuat kueri data performa instans MongoDB.

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:DescribeDBInstancePerformance

get

*dbinstance

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

dds:ResourceTag

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	ID instans. Catatan NodeId diperlukan saat menentukan ID instans cluster sharded	dds-bp2635****
NodeId	string	No	ID node mongos atau shard dalam instans cluster sharded. Parameter ini memungkinkan Anda membuat kueri performa satu node. Catatan Hanya tersedia saat DBInstanceId diatur ke ID instans cluster sharded.	d-bp2287****
Key	string	Yes	Metrik performa. Untuk informasi selengkapnya, lihat Metrik. Catatan Untuk menentukan beberapa metrik, pisahkan dengan koma (,).	CpuUsage
StartTime	string	Yes	Awal rentang waktu yang akan dikueri. Tentukan waktu dalam format yyyy-MM-ddTHH:mmZ. Waktu harus dalam UTC.	2022-06-13T10:58Z
EndTime	string	Yes	Akhir rentang waktu yang akan dikueri. Waktu akhir harus lebih lambat dari waktu mulai. Tentukan waktu dalam format yyyy-MM-ddTHH:mmZ. Waktu harus dalam UTC.	2022-06-13T11:58Z
RoleId	string	No	ID peran node dalam instans mandiri atau replica set. Untuk membuat kueri ID peran, panggil operasi DescribeReplicaSetRole. Catatan Hanya tersedia saat DBInstanceId diatur ke ID instans mandiri atau replica set.	6025****
Interval	string	No	Granularitas data metrik performa dalam detik. Nilai yang valid: 5, 30, 60, 600, 1800, 3600, dan 86400.	60
ReplicaSetRole	string	No	Peran node dalam instans mandiri atau replica set. Nilai yang valid: Primary: Node utama. Secondary: Node sekunder. Catatan Hanya tersedia saat DBInstanceId diatur ke ID instans mandiri atau replica set. Jika DBInstanceId diatur ke ID instans mandiri, parameter ini hanya mendukung nilai Primary.	Primary
SearchId	string	No	ID node Search. Catatan Hanya tersedia setelah fitur Search diaktifkan untuk instans.	dds-2zec12675c9e****-search

Elemen respons

Element	Type	Description	Example
	object
PerformanceKeys	object
PerformanceKey	array<object>	Daftar metrik performa.
	array<object>
Key	string	The performance metric.	CpuUsage
Unit	string	The unit of the performance metric.	%
ValueFormat	string	The format of the performance metric value. If a metric has multiple fields, the fields are separated by ampersands (&). For example, if you query disk space usage, the value of ValueFormat is ins_size&data_size&log_size.	cpu_usage
PerformanceValues	object
PerformanceValue	array<object>	A list of performance metric values.
	object
Value	string	The value of the performance metric.	0.23
Date	string	The time when the metric value was generated.	2022-06-13T10:58:00Z
EndTime	string	Akhir rentang waktu yang akan dikueri. Waktu dalam format yyyy-MM-ddTHH:mmZ. Waktu ditampilkan dalam UTC.	2022-06-13T11:58Z
RequestId	string	ID permintaan.	4A300BC7-6D8F-527F-A2DB-A7768D26E9AC
StartTime	string	Awal rentang waktu yang akan dikueri. Waktu dalam format yyyy-MM-ddTHH:mmZ. Waktu ditampilkan dalam UTC.	2022-06-13T10:58Z

Contoh

Respons sukses

JSONformat

{
  "PerformanceKeys": {
    "PerformanceKey": [
      {
        "Key": "CpuUsage",
        "Unit": "%",
        "ValueFormat": "cpu_usage",
        "PerformanceValues": {
          "PerformanceValue": [
            {
              "Value": "0.23",
              "Date": "2022-06-13T10:58:00Z"
            }
          ]
        }
      }
    ]
  },
  "EndTime": "2022-06-13T11:58Z",
  "RequestId": "4A300BC7-6D8F-527F-A2DB-A7768D26E9AC",
  "StartTime": "2022-06-13T10:58Z"
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidPerformanceKey.Malformed	The specified parameter Key is not valid.
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.
400	InvalidStartTimeAndEndTime.Malformed	The end time must be greater than the start time

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.