Consulta de proyectos empresariales
Función
Esta API se utiliza para consultar proyectos empresariales. Antes de invocar a esta API:
- Aprender cómo autorizar y autenticarla.
- Obtenga la región y el punto de conexión requeridos.
URI
GET /v3/{project_id}/enterprise-projects
Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
project_id | Sí | String | ID de proyecto de un tenant en una región. Para obtener este valor, consulte Obtención de un ID de proyecto. |
Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
offset | No | Integer | Desplazamiento de índice. Si offset se establece en N, la consulta de recursos comienza desde el dato N+1. El valor es 0 de forma predeterminada, lo que indica que la consulta comienza desde el primer dato. El valor no puede ser un número negativo. |
limit | No | Integer | Número de registros que se van a consultar. El valor predeterminado es 100. El valor debe ser un entero positivo. El valor mínimo es de 1 y el valor máximo es de 100. |
Parámetros de solicitud
Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
X-Auth-Token | Sí | String | Token de usuario. Para obtener este valor, invoque a la API de IAM para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el valor del token. |
X-Language | No | String | Tipo de idioma de solicitud. El valor predeterminado es en-us. Valores:
|
Parámetros de respuesta
Código de estado: 200
Parámetro | Tipo | Descripción |
|---|---|---|
enterprise_projects | Array of EnterpriseProjectItem objects | Información del proyecto de empresa. |
total_count | Integer | Número total de proyectos empresariales. |
Parámetro | Tipo | Descripción |
|---|---|---|
id | String | ID de proyecto de empresa. |
name | String | Nombre del proyecto de empresa. |
description | String | Descripción. |
status | String | Estado.
|
created | String | Tiempo de creación en el formato "aaaa-mm-ddThh:mm:ssZ". T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, si el desplazamiento de la zona horaria es de una hora, el valor de Z es de +0100. |
updated | String | Actualice la hora en formato "aaaaa-mm-ddThh:mm:ssZ". T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, si el desplazamiento de la zona horaria es de una hora, el valor de Z es de +0100. |
Código de estado: 400
Parámetro | Tipo | Descripción |
|---|---|---|
error_code | String | Código de error. |
error_msg | String | Mensaje de error. |
Código de estado: 500
Parámetro | Tipo | Descripción |
|---|---|---|
error_code | String | Código de error. |
error_msg | String | Mensaje de error. |
Ejemplo de la solicitud
Consulta de proyectos empresariales
GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/enterprise-projects Ejemplo de la respuesta
Código de estado: 200
Operación exitosa.
{
"total_count" : 4,
"enterprise_projects" : [ {
"id" : 0,
"name" : "default",
"description" : null,
"status" : 1,
"created" : null,
"updated" : null
}, {
"id" : "5c7d11e0-3201-4558-bcce-1172137cf7e2",
"name" : "sjw-eps",
"description" : null,
"status" : 1,
"created" : "2023-06-12T02:14:28+0000",
"updated" : "2023-06-12T02:14:28+0000"
}, {
"id" : "12093327-28dc-46c5-8ba6-d42c9236f9d6",
"name" : "adf",
"description" : null,
"status" : 1,
"created" : "2023-05-06T08:33:03+0000",
"updated" : "2023-05-06T08:33:03+0000"
}, {
"id" : "07d90b3f-422b-40c9-b9b3-6d00d1d7a60b",
"name" : "eps-test",
"description" : null,
"status" : 1,
"created" : "2023-03-16T01:38:13+0000",
"updated" : "2023-03-16T01:38:13+0000"
} ]
} Código de estado
Para más detalles, véase Códigos de estado.
Código de error
Para más detalles, véase Códigos de error.
