Consulta de recursos de empresa por página como administrador de SP
Descripción
Esta API es utilizada por un SP para consultar recursos de empresa que coinciden con condiciones específicas.
Depuración
Puede depurar esta API en Explorador de API.
Prototipo
|
Método de solicitud |
GET |
|---|---|
|
Dirección de solicitud |
/v1/usg/dcs/sp/corp/{corp_id}/resource |
|
Protocolo de transporte |
HTTPS |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Localización |
Descripción |
|---|---|---|---|---|
|
corp_id |
Sí |
String |
Path |
ID de empresa. |
|
offset |
No |
Integer |
Query |
Desplazamiento de consulta. Si el valor excede el número máximo de registros disponibles, se devuelven los registros de la última página. Valor predeterminado: 0. |
|
limit |
No |
Integer |
Query |
Número de registros a consultar. Valor predeterminado: 10. |
|
searchKey |
No |
String |
Query |
Criterios de búsqueda. |
|
startExpireDate |
No |
Integer |
Query |
Si se especifica este parámetro, se consultan los recursos cuyo tiempo de caducidad sea posterior a la fecha especificada. |
|
endExpireDate |
No |
Integer |
Query |
Si se especifica este parámetro, se consultan los recursos cuyo tiempo de caducidad es anterior a la fecha especificada. |
|
type |
No |
String |
Query |
Tipo de recurso. |
|
typeId |
No |
String |
Query |
ID de tipo de recurso. Por ejemplo, si desea consultar salas de reuniones en la nube de cinco participantes, establezca este parámetro en el ID del paquete de salas de reuniones en la nube de cinco participantes. |
|
status |
No |
Integer |
Query |
Estado del recurso.
|
|
X-Access-Token |
Sí |
String |
Header |
Token de autorización. Utilice el valor de accessToken en la respuesta a la solicitud de Autenticación de un ID de aplicación. |
|
X-Request-Id |
No |
String |
Header |
ID de solicitud, que se utiliza para el seguimiento y la localización de fallos. Se recomienda utilizar un UUID. Si este parámetro no se incluye, se genera automáticamente un ID de solicitud. |
|
Accept-Language |
No |
String |
Header |
Idioma. Valores zh-CN para el chino (predeterminado) y en-US para el inglés. |
Códigos de estado
|
Código de estado de HTTP |
Descripción |
|---|---|
|
200 |
Operación exitosa. |
|
400 |
Parámetros no válidos |
|
401 |
La autenticación no se realiza o falla. |
|
403 |
Permisos insuficientes. |
|
500 |
Excepción del servidor. |
Parámetros de respuesta
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
count |
Integer |
Número total de registros. |
|
limit |
Integer |
Número de registros mostrados por página. Valor predeterminado: 10. |
|
offset |
Integer |
Número de la página de inicio de la consulta. El valor comienza desde 0. |
|
data |
Array of QueryResourceResultDTO objects |
Detalles de usuario de empresa. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
count |
Integer |
Cantidad de recursos. |
|
editable |
Boolean |
Si se puede editar o eliminar un recurso. Si el valor es de false, los botones para modificar o eliminar recursos deben estar ocultos en la GUI. |
|
expireDate |
Long |
Hora UTC cuando caduca el recurso. |
|
id |
String |
Identifica de forma única un recurso. Si la solicitud lleva este parámetro, se utiliza el valor del parámetro. De lo contrario, el backend genera automáticamente un UUID. |
|
status |
Integer |
Estado del recurso. |
|
type |
String |
Tipo de recurso. |
|
typeDesc |
String |
Descripción del tipo de recurso. Por ejemplo, si el tipo de recurso es paquete de sala de reuniones en la nube, el valor de este parámetro es el nombre del paquete de sala de reuniones en la nube. |
|
typeId |
String |
ID de tipo de recurso. Por ejemplo, si el tipo de recurso es paquete de sala de reuniones en la nube, el valor de este parámetro es el ID del paquete de sala de reuniones en la nube. |
|
vmrMode |
Integer |
Modo de sala de reuniones en la nube.
|
|
orderId |
String |
ID de pedido correspondiente al recurso. |
Solicitud de ejemplo
GET /v1/usg/dcs/sp/corp/818803911/resource?offset=0&limit=5&searchKey=&startExpireDate=&endExpireDate=&type=&typeId=&status=0 Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Content-Type: application/json Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
Ejemplo de respuesta
HTTP/1.1 200
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 1329
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: 63facce44898efa03629afd189da7f0f
{
"count": 1,
"data": [
{
"count": 10,
"editable": true,
"expireDate": 2549030400000,
"id": "b974dfbe2daf456880afd10c80d12c9f",
"status": 0,
"type": "VMR",
"typeDesc": null,
"typeId": "ff808081699b56cb0169c411a0980152"
}
],
"limit": 5,
"offset": 0
}
Códigos de error
Si se devuelve un código de error que comienza con MMC o USG cuando utiliza esta API, corrija el error siguiendo las instrucciones proporcionadas en el Centro de errores de la API de Huawei Cloud.
Ejemplo de comando cURL
curl -k -i -X GET -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' https://api.meeting.huaweicloud.com/v1/usg/dcs/sp/corp/818803911/resource?offset=0&limit=5&searchKey=&startExpireDate=&endExpireDate=&type=&typeId=&status=0
