GetCheckScopeConfig - Security Center - Alibaba Cloud Documentation Center

Queries the check scope configuration.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:GetCheckScopeConfig

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ConfigId	integer	No	The ID of the configuration. This parameter is optional. If you do not specify this parameter, an ID is automatically generated.	435f626256ebf564cf5ba966a539****
ResourceDirectoryAccountId	integer	No	The ID of the member accounts in the resource directory. Note Invoke the DescribeMonitorAccounts operation to obtain this parameter.	127608589417****

Response elements

Element	Type	Description	Example
	object	GetCheckScopeConfigResponse
RequestId	string	The request ID.	7BC55C8F-226E-5AF5-9A2C-2EC43864****
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Code	string	The result code. A value of 200 indicates success. Any other value indicates failure. You can use this field to determine the cause of the failure.	200
Message	string	The response message.	successful
Data	object	The returned data.
GmtCreate	string	The creation time.	2022-10-16 18:17:16
GmtModified	string	The modification time.	2026-01-09 10:19:57
ConfigId	string	The ID of the configuration.	97a1fed216908e417407344e1505xxxx
Type	integer	The scan scope configuration type. Valid values: 1: scan by instance. 3: scan all.	1
AutoType	integer	The automatic scan configuration type. Valid values: 0: Automatic scan is disabled. 1: Automatically scan newly added cloud assets.	1
AutoConfig	string	The automatic scan configuration as a JSON string. The fields are described as follows: autoInclude: specifies whether to enable automatic scan. Valid values: true: enabled. false: disabled. autoRule: the enablement configuration. ruleOperator: the enablement configuration rule. The value is include. operator: the logical operator. The value is or. rule: the rule. condition: the rule condition. Valid values: vendor: vendor. assetType: level-1 asset type. assetSubType: level-2 asset type. Note For specific meanings, refer to the GetCloudAssetCriteria operation.	"{\"autoInclude\":true,\"autoRule\":{\"ruleOperator\":\"include\",\"operator\":\"or\",\"rule\":[{\"condition\":\"assetSubType\",\"ruleOperator\":\"include\",\"value\":[{\"vendor\":\"0\",\"assetType\":\"0\",\"assetSubType\":\"100\"}]}]}}"

Examples

Success response

JSON format

{
  "RequestId": "7BC55C8F-226E-5AF5-9A2C-2EC43864****",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "Data": {
    "GmtCreate": "2022-10-16 18:17:16",
    "GmtModified": "2026-01-09 10:19:57",
    "ConfigId": "97a1fed216908e417407344e1505xxxx",
    "Type": 1,
    "AutoType": 1,
    "AutoConfig": "\"{\\\"autoInclude\\\":true,\\\"autoRule\\\":{\\\"ruleOperator\\\":\\\"include\\\",\\\"operator\\\":\\\"or\\\",\\\"rule\\\":[{\\\"condition\\\":\\\"assetSubType\\\",\\\"ruleOperator\\\":\\\"include\\\",\\\"value\\\":[{\\\"vendor\\\":\\\"0\\\",\\\"assetType\\\":\\\"0\\\",\\\"assetSubType\\\":\\\"100\\\"}]}]}}\""
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	RdCheckNoPermission	Resource directory account verification has no permission.
500	ServerError	ServerError
500	RdCheckInnerError	Resource directory account service internal error.
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.