Querying Services

Function

This API is used to query the service list.

URI

• URI format

  GET /v3/services{?type}

• URI parameters

  Parameter	Mandatory	Type	Description
  type	No	String	Service type. The value can be compute, ec2, identity, image, network, or volume.

Request Parameters

• Parameters in the request header

  Parameter	Mandatory	Type	Description
  Content-Type	Yes	String	Fill application/json;charset=utf8 in this field.
  X-Auth-Token	Yes	String	Authenticated token.

• Example request

  curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X GET https://sample.domain.com/v3/services?type=compute

Response Parameters

• Parameters in the response body

  Parameter	Mandatory	Type	Description
  links	Yes	Dict	Service resource link.
  services	Yes	List	A list of services.

• Description for the services format

  Parameter	Mandatory	Type	Description
  description	No	String	Service description.
  enabled	Yes	Boolean	Whether a service is available.
  id	Yes	String	Service ID.
  name	No	String	Service name.
  type	Yes	String	Service type.
  links	Yes	Dict	Service resource link.

• Example response (successful response)

  {
      "services": [
          {
              "name": "compute5",
              "links": {
                  "self": "https://sample.domain.com/v3/services/053d21d488d1463c818132d9d08fb617"
              },
              "enabled": true,
              "type": "compute",
              "id": "053d21d488d1463c818132d9d08fb617",
              "description": "Compute service 5"
          },
          {
              "name": "compute3",
              "links": {
                  "self": "https://sample.domain.com/v3/services/c2474183dca7453bbd73123a0b78feae"
              },
              "enabled": true,
              "type": "compute",
              "id": "c2474183dca7453bbd73123a0b78feae",
              "description": "Compute service 3"
          },
          {
              "name": "compute2",
              "links": {
                  "self": "https://sample.domain.com/v3/services/c7166694ebdd4616bd927737f7b12ca2"
              },
              "enabled": true,
              "type": "compute",
              "id": "c7166694ebdd4616bd927737f7b12ca2",
              "description": "Compute service 2"
          }
      ],
      "links": {
          "self": "https://sample.domain.com/v3/services?type=compute",
          "previous": null,
          "next": null
      }
  }

Status Codes