Query Environment Information

Use this API to retrieve available environments in NineData. Filter by environment name and use the returned environment IDs when creating or updating data sources.

Request URL: /openapi/v1/env/list

Request Method: GET

Request Parameters

Parameter	Type	Required	Description	Example
name	String	No	Environment name.	Production Env
current	Integer	No	Current page, starting from 1, default is 1.	1
pageSize	Integer	No	Page size, default is 10.	50

Response Parameters

Parameter	Type	Description	Example
success	Bool	Whether the API call was successful. Return values: true, false.	true
requestId	String	Request ID.	Xh4k7XPF-IOLLqNYnJOIf0VFdOQe9SIO
data	Array	Environment list, including environment ID (envId), environment name (name), and other information.	{ "envId": "env-product", "name": "Production" }
current	Integer	Current page number.	1
pageSize	Integer	Size per page.	10
total	Integer	Total number of environments.	2

Successful Invocation Example

{
    "success": true,
    "requestId": "Xh4k7XPF-IOLLqNYnJOIf0VFdOQe9SIO",
    "data": [{
        "envId": "env-product",
        "name": "Production"
    }, {
        "envId": "env-dev",
        "name": "Test"
    }],
    "current": 1,
    "pageSize": 10,
    "total": 2
}

Result

A successful response returns environments that match the filters. Use the returned envId when you bind a data source to an environment.