DescribeDBInstancePerformance - - Alibaba Cloud Dokümantasyon Merkezi

Bir MongoDB örneğinin performans verilerini sorgular.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dds:DescribeDBInstancePerformance

get

*dbinstance

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

dds:ResourceTag

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	Örnek kimliği. Not Parçalanmış küme örneği kimliği belirtilirken NodeId gereklidir.	dds-bp2635****
NodeId	string	No	Parçalanmış küme örneğindeki bir mongos veya shard düğümünün kimliği. Bu parametre, tek bir düğümün performansını sorgulamanızı sağlar. Not Yalnızca DBInstanceId bir parçalanmış küme örneğinin kimliğine ayarlandığında kullanılabilir.	d-bp2287****
Key	string	Yes	Performans metrikleri. Daha fazla bilgi için Metrikler bölümüne bakın. Not Birden fazla metrik belirtmek için bunları virgül (,) ile ayırın.	CpuUsage
StartTime	string	Yes	Sorgulanacak zaman aralığının başlangıcı. Zamanı yyyy-MM-ddTHH:mmZ biçiminde belirtin. Zaman UTC olmalıdır.	2022-06-13T10:58Z
EndTime	string	Yes	Sorgulanacak zaman aralığının sonu. Bitiş zamanı, başlangıç zamanından sonra olmalıdır. Zamanı yyyy-MM-ddTHH:mmZ biçiminde belirtin. Zaman UTC olmalıdır.	2022-06-13T11:58Z
RoleId	string	No	Bağımsız veya çoğaltma kümesi örneğindeki bir düğümün rol kimliği. Rol kimliğini sorgulamak için DescribeReplicaSetRole işlemini çağırın. Not Yalnızca DBInstanceId bir bağımsız veya çoğaltma kümesi örneğinin kimliğine ayarlandığında kullanılabilir.	6025****
Interval	string	No	Performans metriklerinin saniye cinsinden veri ayrıntı düzeyi. Geçerli değerler: 5, 30, 60, 600, 1800, 3600 ve 86400.	60
ReplicaSetRole	string	No	Bağımsız veya çoğaltma kümesi örneğindeki bir düğümün rolü. Geçerli değerler: Primary: Birincil düğüm. Secondary: İkincil düğüm. Not Yalnızca DBInstanceId bir bağımsız veya çoğaltma kümesi örneğinin kimliğine ayarlandığında kullanılabilir. DBInstanceId bağımsız bir örneğin kimliğine ayarlanmışsa, bu parametre yalnızca Primary değerini destekler.	Primary
SearchId	string	No	Search düğümü kimliği. Not Yalnızca örnek için Search özelliği etkinleştirildikten sonra kullanılabilir.	dds-2zec12675c9e****-search

Response elements

Element	Type	Description	Example
	object
PerformanceKeys	object
PerformanceKey	array<object>	Performans metriklerinin listesi.
	array<object>
Key	string	Performans metriği.	CpuUsage
Unit	string	Performans metriğinin birimi.	%
ValueFormat	string	Performans metriği değerlerinin biçimi. Bir performans metriği birden fazla alan içeriyorsa, alanlar ve işareti (&) ile ayrılır. Örneğin, disk alanı kullanımını sorgularsanız, döndürülen ValueFormat ins_size&data_size&log_size olur.	cpu_usage
PerformanceValues	object
PerformanceValue	array<object>	Performans metriği değerlerinin listesi.
	object
Value	string	Performans metriğinin değeri.	0.23
Date	string	Performans metriği değerinin oluşturulduğu zaman.	2022-06-13T10:58:00Z
EndTime	string	Sorgulanacak zaman aralığının sonu. Zaman yyyy-MM-ddTHH:mmZ biçimindedir. Zaman UTC olarak görüntülenir.	2022-06-13T11:58Z
RequestId	string	İstek kimliği.	4A300BC7-6D8F-527F-A2DB-A7768D26E9AC
StartTime	string	Sorgulanacak zaman aralığının başlangıcı. Zaman yyyy-MM-ddTHH:mmZ biçimindedir. Zaman UTC olarak görüntülenir.	2022-06-13T10:58Z

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
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	The end time cannot be earlier than the start time.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.