All Products
Search
Document Center

Artificial Intelligence Recommendation:DescribeRule

Last Updated:Sep 16, 2025

Queries detailed information about a rule.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
airec:DescribeRuleget
*Instance
acs:airec:{#regionId}:{#accountId}:instance/{#InstanceId}
    none
none

Request syntax

GET /v2/openapi/instances/{instanceId}/rules/{ruleId} HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The ID of the rule.

airec-cn-o400whm78004
ruleIdstringYes

The ID of the scene.

xxx
sceneIdstringYes

The type of the rule.

Valid values: selection and operation.

xxx
ruleTypestringYes

The returned result.

selection

Response parameters

ParameterTypeDescriptionExample
object
resultobject

The ID of the rule.

ruleIdstring

The time when the rule was last modified.

98493A14-D619-4E88-9F8D-108939817F9F
gmtModifiedstring

The state of the rule.

2020-04-27T06:38:28.000Z
statusstring

The time when the rule was created.

DRAFT
gmtCreatestring

The error code.

2020-04-27T06:38:28.000Z
codestring

The ID of the request.

InternalServerError
requestIdstring

The error message.

8F81A922-6C81-46D6-B78C-CC35E16B1691
messagestring

null

An internal server error occurred

Examples

Sample success responses

JSONformat

{
  "result": {
    "ruleId": "98493A14-D619-4E88-9F8D-108939817F9F",
    "gmtModified": "2020-04-27T06:38:28.000Z",
    "status": "DRAFT",
    "gmtCreate": "2020-04-27T06:38:28.000Z"
  },
  "code": "InternalServerError",
  "requestId": "8F81A922-6C81-46D6-B78C-CC35E16B1691",
  "message": "An internal server error occurred"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history