Retrieve container
ContainerRetrieveResponse containers().retrieve(ContainerRetrieveParamsparams = ContainerRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
get /containers/{container_id}
Retrieve Container
Parameters
-
ContainerRetrieveParams paramsOptional<String> containerId
Returns
-
class ContainerRetrieveResponse:-
String idUnique identifier for the container.
-
long createdAtUnix timestamp (in seconds) when the container was created.
-
String nameName of the container.
-
String object_The type of this object.
-
String statusStatus of the container (e.g., active, deleted).
-
Optional<ExpiresAfter> expiresAfterThe container will expire after this time period. The anchor is the reference point for the expiration. The minutes is the number of minutes after the anchor before the container expires.
-
Optional<Anchor> anchorThe reference point for the expiration.
LAST_ACTIVE_AT("last_active_at")
-
Optional<Long> minutesThe number of minutes after the anchor before the container expires.
-
-
Optional<Long> lastActiveAtUnix timestamp (in seconds) when the container was last active.
-
Optional<MemoryLimit> memoryLimitThe memory limit configured for the container.
-
_1G("1g") -
_4G("4g") -
_16G("16g") -
_64G("64g")
-
-
Optional<NetworkPolicy> networkPolicyNetwork access policy for the container.
-
Type typeThe network policy mode.
-
ALLOWLIST("allowlist") -
DISABLED("disabled")
-
-
Optional<List<String>> allowedDomainsAllowed outbound domains when
typeisallowlist.
-
-
Example
package com.openai.example;
import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.containers.ContainerRetrieveParams;
import com.openai.models.containers.ContainerRetrieveResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
OpenAIClient client = OpenAIOkHttpClient.fromEnv();
ContainerRetrieveResponse container = client.containers().retrieve("container_id");
}
}
Response
{
"id": "id",
"created_at": 0,
"name": "name",
"object": "object",
"status": "status",
"expires_after": {
"anchor": "last_active_at",
"minutes": 0
},
"last_active_at": 0,
"memory_limit": "1g",
"network_policy": {
"type": "allowlist",
"allowed_domains": [
"string"
]
}
}