All Products
Search
Document Center

Application Real-Time Monitoring Service:OpenVCluster

Last Updated:Nov 05, 2024

Activates a virtual cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
arms:OpenVClusternone
  • Prometheus
    acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
ClusterTypestringYes

The type of the cluster. For cloud services, set this parameter to cloud-product-prometheus.

cloud-product-prometheus
LengthintegerNo

The length of the cluster ID. Default value: 10.

10
ProductstringNo

The name of the cloud service. This parameter must be specified when ClusterType is set to cloud-product-prometheus. Valid values: influxdb, mongodb, and DLA. You cannot specify multiple service names.

influxdb
RecreateSwitchbooleanNo

Specifies whether to create or query a virtual cluster. This parameter provides backward compatibility.

false

Response parameters

ParameterTypeDescriptionExample
object

The returned struct.

Datastring

The cluster ID.

rre59xelcx
RequestIdstring

The request ID. You can use the ID to query logs and troubleshoot issues.

42E58E4D-ACAD-4400-8FAF-F762340AE5B3

Examples

Sample success responses

JSONformat

{
  "Data": "rre59xelcx",
  "RequestId": "42E58E4D-ACAD-4400-8FAF-F762340AE5B3"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history