All Products
Search
Document Center

CloudMonitor:DescribeMonitoringAgentAccessKey

Last Updated:Jul 26, 2024

Queries the AccessKey ID and AccessKey secret that are required to install the CloudMonitor agent on a third-party host.

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
cms:DescribeMonitoringAgentAccessKeyget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
AccessKeystring

The AccessKey ID that is required to install the agent.

E7A27f9****
SecretKeystring

The AccessKey secret that is required to install the agent.

sBjNOUhLylrxMX-Xv1****
RequestIdstring

The request ID.

C0F655E9-D793-51E6-BD78-CABBCCFC1047
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Codeinteger

The status code.

Note The status code 200 indicates that the request was successful.
200
Messagestring

The error message.

The specified resource is not found.

Examples

Sample success responses

JSONformat

{
  "AccessKey": "E7A27f9****",
  "SecretKey": "sBjNOUhLylrxMX-Xv1****",
  "RequestId": "C0F655E9-D793-51E6-BD78-CABBCCFC1047",
  "Success": true,
  "Code": 200,
  "Message": "The specified resource is not found."
}

Error codes

HTTP status codeError codeError messageDescription
400ParameterInvalidIllegal parameters.-
403AccessForbiddenUser not authorized to operate on the specified resource.-
404ResourceNotFoundThe specified resource is not found.The specified resource is not found.
500InternalErrorThe request processing has failed due to some unknown error.-

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

Change history

Change timeSummary of changesOperation
No change history