DescribeAssetScope

Updated at:

Queries the effective scope mode, target list, and scope record information based on the asset scope ID.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

Id

integer

Yes

The ID of the asset scope to query.

1932

Response elements

Element

Type

Description

Example

object

RequestId

string

The unique identifier of the request. This ID is used for troubleshooting and issue tracking.

01A157FA-F957-3A5A-A6B8-5BBB8ADB****

Data

object

The details of the endpoint asset scope.

Id

integer

The ID of the asset scope record, which corresponds to the Id request parameter.

1932

MatchMode

string

The effective scope mode. Valid values:

  • UserGroupAll: All user groups.

  • UserGroupNormal: Specified user groups.

  • DeviceGroupNormal: Specified device groups.

  • DevTagNormal: Specified device tags.

The meaning of MatchTargetIds is determined by this field.

UserGroupNormal

MatchTargetIds

array

The list of effective scope targets. All elements are strings. The meaning of each element is determined by MatchMode:

  • UserGroupAll: Scope matching does not depend on this list.

  • UserGroupNormal: The user group ID.

  • DeviceGroupNormal: The device group ID.

  • DevTagNormal: The device tag value.

This list is not a list of matched endpoint UUIDs.

string

An effective scope target, which can represent a user group ID, a device group ID, or a device tag value. The specific meaning is determined by MatchMode.

1

GmtCreate

integer

[Deprecated] This field is deprecated.

1792800000000

GmtModified

integer

[Deprecated] This field is deprecated.

1792803600000

Examples

Success response

JSON format

{
  "RequestId": "01A157FA-F957-3A5A-A6B8-5BBB8ADB****",
  "Data": {
    "Id": 1932,
    "MatchMode": "UserGroupNormal",
    "MatchTargetIds": [
      "1"
    ],
    "GmtCreate": 1792800000000,
    "GmtModified": 1792803600000
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.