[説明] このページは機械翻訳された日本語版です。内容に誤りがございましたら、報告していただけると助かります。

Describe Project (V2)

This operation returns the details of a specified project.

GET

/v2/projects/{projectId}

Base URL

The base URL for this API is in the following format:

https://api.cloud.zilliz.com

📘Notes

The endpoints on the control plane currently supports up to 20 requests per second per user per endpoint.

export BASE_URL="https://api.cloud.zilliz.com"

Parameters

Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges or a pair of colon-joined username and password, like username:password.

Example Value: Bearer {{TOKEN}}

projectIdstringpathrequired

The ID of the project to describe.

Example Value: proj-xx

export TOKEN="YOUR_API_KEY"
export projectId="proj-xx"

curl --request GET \
--url "${BASE_URL}/v2/projects/${projectId}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"

Responses200 - application/json

SUCCESS

A success response

codeinteger

Response code.

Example Value: 0

dataobject

Response payload which contains the details of the specified project.

projectIdstring

ID of the project.

projectNamestring

Name of the project.

instanceCountinteger

Number of clusters in the project.

createTimestring

Time at which the project is created.

planstring

The subscription plan of the current project. The possible values are Standard and Enterprise.

FAILURE

A failure response.

codeinteger

Response code.

messagestring

Error message.

SUCCESS

{
    "code": 0,
    "data": {
        "projectId": "proj-x",
        "projectName": "My Project",
        "instanceCount": 2,
        "createTime": "2023-08-16T07:34:06Z",
        "plan": "Enterprise"
    }
}