All Products
Search

This Product

    ApsaraDB RDS:DescribeDBInstancesByPerformance

    Document Center

    ApsaraDB RDS:DescribeDBInstancesByPerformance

    Last Updated:Sep 13, 2024

    You can call the DescribeDBInstancePerformance operation to query the performance of instances.

    Operation description

    This operation is phased out.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    rds:DescribeDBInstancesByPerformanceget
    • DBInstance
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.

    		ETnLKlblzczshOTUbOCzxxxxxx
    proxyIdstringNo

    The ID of the proxy mode.

    		API
    DBInstanceIdstringNo

    The ID of the instance.

    		rm-uf6wjk5xxxxxx
    PageSizeintegerNo

    The number of entries to return on each page. Valid values: 5 to 100.

    Default value: 30.

    		30
    PageNumberintegerNo

    The number of the page to return. Valid values: any non-zero positive integer.

    Default value: 1.

    		1
    SortMethodstringNo

    The sorting method.

    		ASC
    SortKeystringNo

    The sorting basis.

    		CPU_Usage
    TagsstringNo

    The tags that are added to the instances. Each tag is a key-value pair that consists of two parts: TagKey and TagValue. Format: {"key1":"value1"}.

    		{"key1":"value1"}
    Tag.1.keystringNo

    The key of tag 1 that is added to the instances.

    		key1
    Tag.2.keystringNo

    The key of tag 2 that is added to the instances.

    		key2
    Tag.3.keystringNo

    The key of tag 3 that is added to the instances.

    		key3
    Tag.4.keystringNo

    The key of tag 4 that is added to the instances.

    		key4
    Tag.5.keystringNo

    The key of tag 5 that is added to the instances.

    		key5
    Tag.1.valuestringNo

    The value of tag 1 that is added to the instances.

    		value1
    Tag.2.valuestringNo

    The value of tag 2 that is added to the instances.

    		value2
    Tag.3.valuestringNo

    The value of tag 3 that is added to the instances.

    		value3
    Tag.4.valuestringNo

    The value of tag 4 that is added to the instances.

    		value4
    Tag.5.valuestringNo

    The value of tag 5 that is added to the instances.

    		value5
    RegionIdstringNo

    The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    ResourceGroupIdstringNo

    The ID of the resource group.

    		rg-acfmy*****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The ID of the request.

    		23907437-79B9-411A-9EE6-75A8F0F1C619
    PageNumberinteger

    The page number of the returned page.

    		1
    PageRecordCountinteger

    The number of entries returned on the current page.

    		28
    TotalRecordCountinteger

    The total number of entries returned.

    		28
    Itemsarray<object>

    The details about the instance.

    object

    The details about the instance.

    CPUUsagestring

    The CPU utilization of the instance in percentage.

    		0.70
    SessionUsagestring

    The number of sessions.

    		0.10
    DBInstanceIdstring

    The ID of the instance.

    		rm-uf6wjk5xxxxxx
    DBInstanceDescriptionstring

    The name of the instance.

    		DatabaseTest
    IOPSUsagestring

    The IOPS usage of the instance in percentage.

    		0.15
    DiskUsagestring

    The disk usage of the instance in percentage.

    		14.56

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "23907437-79B9-411A-9EE6-75A8F0F1C619",
  "PageNumber": 1,
  "PageRecordCount": 28,
  "TotalRecordCount": 28,
  "Items": {
    "DBInstancePerformance": [
      {
        "CPUUsage": "0.70",
        "SessionUsage": "0.10",
        "DBInstanceId": "rm-uf6wjk5xxxxxx",
        "DBInstanceDescription": "DatabaseTest",
        "IOPSUsage": "0.15",
        "DiskUsage": "14.56"
      }
    ]
  }
}

    Error codes

    For a list of error codes, visit the Service error codes.