Jump to

• Request
• Response

Retrieve details of an schedulled vector index job.

get

/vecdb/vector-indexes/jobs/{index_job_name}/

Describes the specified job scheduled to create a vector index.

Request

Path Parameters

• index_job_name(required): string
  The name of the vector index job.

There's no request body for this operation.

Security

• BasicAuth: http
  Type: http
• BearerAuth: http
  Type: http
• OAuth2: oauth2
  Type: oauth2

Back to Top

Response

Supported Media Types

• application/json
• application/problem+json

200 Response

Description of the vector index creation or rebuild job that have been created.

Body ()

Root Schema : VecDBJobItem

Type: object

Show Source

• job_creator: string
• job_name: string
• job_type: string
• links: array links
• operation: string
• start_date: string
• state: string

{
    "type":"object",
    "properties":{
        "job_name":{
            "type":"string"
        },
        "job_creator":{
            "type":"string"
        },
        "job_type":{
            "type":"string"
        },
        "operation":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "start_date":{
            "type":"string",
            "nullable":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LinkRelation"
    }
}

Nested Schema : LinkRelation

Type: object

Show Source

• href(required): string
• rel(required): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

404 Response

The specified index job was not found.

Body ()

Root Schema : ORDSErrorResponse

Type: object

Show Source

• code(required): string
• diagnosticTrace: string
• instance(required): string
• message(required): string
• stackTrace: string
• type(required): string

{
    "type":"object",
    "required":[
        "code",
        "message",
        "type",
        "instance"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "instance":{
            "type":"string"
        },
        "diagnosticTrace":{
            "type":"string"
        },
        "stackTrace":{
            "type":"string"
        }
    }
}

Back to Top