describe_index_job

Use the describe index job operation to describe the current state of an index job.

Retrieve metadata and status for a specific index build job.

Returns details about an asynchronous index creation or rebuild job, including its current state, progress, owner, and log file location.

Parameters

Parameter	Type	Value Range	Required	Default	Description	Notes
index_job_name	str	Valid string	Yes	No default	Name of the index job to describe.	Use a job name returned by create_index() or list_index_jobs().

Raises InvalidIndexJobNameFormatError is raised when the index job name is invalid.

Describe an index job

job = client.describe_index_job(
    index_job_name="VECDB_CREATE_INDEX_ABC123"
)

Retrieve a failure log

Use the described job to retrieve diagnostics when the job fails.

if job.state == "FAILED":
    job_log = client.get_index_job_log(
        index_job_name=job.job_name
    )
    print(job_log.to_dict())

Return type JobResponse

Returns JSON response describing the index job.

Example response:

{
    "job_name": "VECDB_CREATE_INDEX_ABC123",
    "job_creator": "VECTOR3",
    "operation": "CREATE",
    "state": "SUCCEEDED",
    "links": [
        {
            "rel": "collection",
            "href": "https://<host>/ords/<schema>/_/db-api/stable/vecdb/vector-indexes/jobs/"
        },
        {
            "rel": "self",
            "href": "https://<host>/ords/<schema>/_/db-api/stable/vecdb/vector-indexes/jobs/vecdb_create_index_abc123/"
        },
        {
            "rel": "related",
            "href": "https://<host>/ords/<schema>/_/db-api/stable/vecdb/vector-indexes/jobs/vecdb_create_index_abc123/jobfile"
        }
    ]
}