Jump to

• Request
• Response

Retrieve all schedulled vector indexes jobs.

get

/vecdb/vector-indexes/jobs/

Describes all of the jobs scheduled to create or rebuild a vector index.

Request

There are no request parameters for this operation.

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

200 Response

Description of all the jobs that have been created.

Body ()

Root Schema : VecDBJobCollection

Type: object

Show Source

• count: integer
  Total number of records in the current response.
• hasMore: boolean
  Indicates if there are more records to be retrieved.
• items: array items
• limit: integer
  The actual page size limit on number of records applied by the server.
• links: array links
• offset: integer
  The actual index from which the item resources are returned.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VecDBJobItem"
            }
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates if there are more records to be retrieved."
        },
        "limit":{
            "type":"integer",
            "description":"The actual page size limit on number of records applied by the server."
        },
        "offset":{
            "type":"integer",
            "description":"The actual index from which the item resources are returned."
        },
        "count":{
            "type":"integer",
            "description":"Total number of records in the current response."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object VecDBJobItem

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested 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"
    ]
}

Back to Top