Querying the Multi-Account List

Function

This API is used to query the multi-account list.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/setting/account/accounts

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Definition Specifies the security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. Constraints N/A Range The value contains 1 to 2,048 characters. Default Value N/A
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A
region	No	String	Definition Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID used for task tracing. The value format is request_uuid-timestamp-hostname.

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Definition Total number. Range The value range is 0 to 2,147,483,647.
data_list	Array of AccountResponseInfo objects	Event list details.

**Table 5** AccountResponseInfo
Parameter	Type	Description
account_name	String	Definition Unique name of an account, which is used to identify the account. Range The value can contain 1 to 64 characters, including letters, numbers, hyphens (-), and underscores (_). It cannot start or end with a special character.
account_id	String	Definition Unique ID of an account, which uniquely identifies an account. Range The value is a string of 1 to 64 characters and complies with the naming rules of the platform account ID (for example, UUID or numbers).
organization_id	String	Definition Unique ID of the organization that the account belongs to. Range The value is a string of 1 to 64 characters and must comply with the naming rule of the platform organization ID.
project_id	String	Definition Unique ID of the project that the account belongs to. Range The value is a string of 1 to 64 characters and must comply with the naming rule of the platform project ID.
project_name	String	Definition Name of the project that the account belongs to, which is used to identify the project. Range The value can contain 1 to 64 characters, including letters, numbers, hyphens (-), and underscores (_). There is no complexity requirement.
host_num	Integer	Definition Total number of servers associated with the current account. Range Non-negative integer. The minimum value is 0 and the maximum value depends on the platform resource quota.
vulnerability_num	Integer	Definition Total number of vulnerabilities on the servers under the current account. Range The value is a non-negative integer ranging from 0 to 2,147,483,647.
baseline_num	Integer	Definition Total number of risks that failed the server baseline check under the current account. Range The value is a non-negative integer ranging from 0 to 2,147,483,647.
intrusion_num	Integer	Definition Total number of security intrusion alarms on the servers under the current account. Range The value is a non-negative integer ranging from 0 to 2,147,483,647.

Example Requests

This API is used to query all accounts.

GET https://{endpoint}/v5/setting/account/accounts?offset=0&limit=200&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "data_list" : [ {
    "account_name" : "scc_cnfw",
    "account_id" : "6a321faa6e6c4a18b5bf19dd954377b5",
    "organization_id" : "o-jbg8sokerqszi0zdo6vvaulwdsenonxz",
    "project_id" : "2349ba469daf4b7daf268bb0261d18b0",
    "project_name" : "cn-north-7",
    "host_num" : 11,
    "vulnerability_num" : 0,
    "baseline_num" : 77,
    "intrusion_num" : 0
  } ],
  "total_num" : 1
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Installation and Configuration

Previous topic: Installation and Configuration

Next topic: Deleting an Account

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot