URL Description
AI-VAULT APIs are designed based on the RESTful architecture.
Representational State Transfer (REST) observes the entire network from the resource perspective. Resources are identified by Uniform Resource Identifiers (URIs) across the network and applications from a client obtain resources through Uniform Resource Locators (URLs).
- A URL can contain path parameters. For example, in https://localhost:26335/rest/uam/v1/roles/{parm1}/{parm2}, parm1 and parm2 are path parameters. You can also add query conditions by appending question marks (?) and ampersands (&) to the URL. For example, in https://localhost:26335/rest/uam/v1/roles/{parm1}/{parm2}?parm3=value3&parm4=value4, parm3 and parm4 are query parameters, and value3 and value4 are their values, respectively.
- A URL cannot contain URL special characters (defined by RFC1738). Encode the URL if special characters are required.
- AI-VAULT automatically redirects the URL. For example, https://ip:port/AIVAULT/v1/version/ can be accessed without adding a slash (/) at the end.
Request URI
A request URI is in the following format:
{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}
Although a request URI is included in a request header, most programming languages or frameworks require the request URI to be separately transmitted, rather than being conveyed in a request message.
- URI-scheme:
Protocol used to transmit requests. All APIs use HTTPS.
- Endpoint:
Domain name or IP address of the server bearing the REST service endpoint. (Generally, the value is the IP address of the master node in the Kubernetes cluster, and the default port number is 6443.) You can obtain the value from the administrator.
- resource-path:
Path in which the requested resource is located, that is, the API access path. For example, the resource-path of the API for obtaining all Volcano jobs in a namespace is /apis/batch.volcano.sh/v1alpha1/namespaces/{namepace}/jobs, in which {namespace} indicates the command space of the job.
- query-string:
Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of "Parameter name=Parameter value". For example, ? limit=10 indicates that a maximum of 10 data records will be displayed.
To simplify the URI display in this document, each API is provided only with a resource-path and a request method. The URI-scheme of all APIs is HTTPS, and the endpoints of all APIs in the same region are identical.