Querying DDM Accounts

Function

This API is used to query DDM accounts.

Constraints

None

URI

GET /v1/{project_id}/instances/{instance_id}/users?offset={offset}&limit={limit}

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
instance_id	Yes	String	DDM instance ID

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Index offset. The query starts from the next piece of data indexed by this parameter. The value is 0 by default. The value must be a positive integer.
limit	No	Integer	A maximum of DDM accounts to be queried. Value range: 1 to 128. If the parameter value is not specified, 10 accounts are queried by default.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
users	Array of `GetUsersListDetailResponses <ddm_api_01_0043__response_getuserslistdetailresponses>` objects	DDM account information
page_no	Integer	Current page
page_size	Integer	Data records on the current page
total_record	Integer	Total records
total_page	Integer	Total pages

**Table 5** GetUsersListDetailResponses
Parameter	Type	Description
name	String	Username of the DDM account
status	String	Status of the DDM account
base_authority	Array of strings	Basic permissions of the DDM account. The value can be CREATE, DROP, ALTER, INDEX, INSERT, DELETE, UPDATE, or SELECT.
description	String	Description of the DDM account
created	Integer	Time when the DDM account is created
databases	Array of `GetUsersListdatabase <ddm_api_01_0043__response_getuserslistdatabase>` objects	Associated schemas

**Table 6** GetUsersListdatabase
Parameter	Type	Description
name	String	Name of the schema associated with the DDM account
description	String	Schema description

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
errCode	String	Service error code
externalMessage	String	Error message

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
errCode	String	Service error code
externalMessage	String	Error message

Example Request

GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/users?offset={offset}&limit={limit}

Example Response

Status code: 200

{
  "users" : [ {
    "name" : "ddmtest",
    "status" : "RUNNING",
    "base_authority" : [ "SELECT" ],
    "description" : "Account",
    "created" : 1686904661709,
    "databases" : [ {
      "name" : "test",
      "description" : "Schema"
    } ]
  } ],
  "page_no" : 1,
  "page_size" : 10,
  "total_record" : 1,
  "total_page" : 1
}

Status code: 400

bad request

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

Status code: 500

server error

{
  "externalMessage" : "Server failure.",
  "errCode" : "DBS.200412"
}

Status Codes

Status Code	Description
200	OK
400	bad request
500	server error

Error Codes

For details, see Error Codes <ddm_api_01_0061>.

13 KiB Raw Blame History