Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Cómputo
Elastic Cloud Server
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Redes
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Gestión y gobernanza
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
Cloud Operations Center
Resource Governance Center
Migración
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Análisis
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
IoT
IoT Device Access
Otros
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Seguridad y cumplimiento
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Servicios multimedia
Media Processing Center
Video On Demand
Live
SparkRTC
Almacenamiento
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Contenedores
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Bases de datos
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Aplicaciones empresariales
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Data Lake Factory
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Distribución de contenido y cómputo de borde
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Soluciones
SAP Cloud
High Performance Computing
Servicios para desarrolladores
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
Cloud Application Engine
aPaaS MacroVerse
KooPhone
KooDrive
En esta página

Mostrar todo

Modelo de objetos

Actualización más reciente 2023-03-29 GMT+08:00

En esta sección se describen los modelos de objeto de servicio de API y backend.

NOTA:
  • Operation Type indica la operación que se puede realizar en un campo.

    C: crear; U: actualizar; R: leer

  • Mandatory indica si un campo con el Operation Type de C es obligatorio.
Tabla 1 Modelo de objetos de API

Parámetro

Tipo

Descripción

Tipo de operación

Obligatorio

id

String

ID de API

R

-

name

String

Nombre de la API

CRU

group_id

String

ID del grupo de API al que pertenece la API

CR

type

Integer

Tipo de API, que puede ser:

  • 1: público
  • 2 privado

CRU

status

Integer

Estado de la API, que puede ser:

  • 1: enabled
  • 2: disabled
  • 3: deleted

Valor predeterminado: 1

Este parámetro no se utiliza actualmente.

R

-

version

String

Versión de la API

CRU

No

req_protocol

String

Protocolo de solicitud, que puede ser:

  • HTTP
  • HTTPS
  • BOTH: Se puede acceder a la API a través de HTTP y HTTPS.

Valor predeterminado: HTTPS

CRU

No

req_method

String

Método de solicitud, que puede ser:

  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY

CRU

req_uri

String

Dirección de acceso (URI) de la API, excluidos el nombre de dominio, el número de puerto y el protocolo de solicitud

CRU

auth_type

String

Modo de autenticación de seguridad, que puede ser:

  • NONE
  • APP
  • IAM
  • AUTHORIZER

CRU

authorizer_id

String

ID del autorizador personalizado de frontend

CRU

No

match_mode

String

Modo de coincidencia de rutas, que puede ser:

  • SWA: coincidencia de prefijo
  • NORMAL: coincidencia exacta

CRU

arrange_necessary

Integer

Indica si se requiere orquestación. El valor puede ser:

  • 1: sí
  • 2: no

Valor predeterminado 2

R

-

backend_type

String

Tipo de backend, que puede ser:

  • HTTP (web)
  • FUNCTION
  • MOCK

CRU

register_time

Timestamp

Hora en que se creó la API

R

-

update_time

Timestamp

Hora de la última modificación de la API

R

-

remark

String

Descripción de la API

CRU

No

tag

String

Etiqueta de API

CRU

No

cors

String

Indica si se admite el uso compartido de recursos entre orígenes (CORS)

  • TRUE: soportado
  • FALSE: no soportado

Valor predeterminado: FALSE

CRU

No

response_id

String

ID de la respuesta personalizada

CRU

No

Tabla 2 Web backend object model

Parámetro

Tipo

Descripción

Tipo de operación

Obligatorio

id

String

ID de backend de Web

R

-

status

Integer

Estado del backend de web, que puede ser:

  • 1: enabled
  • 2: disabled
  • 3: deleted

Valor predeterminado: 1

Este parámetro no se utiliza actualmente.

R

-

version

String

Versión del backend de web

CRU

No

url_domain

String

Punto de conexión de backend

CRU

req_protocol

String

Protocolo de solicitud, que puede ser:

  • HTTP
  • HTTPS

CRU

req_method

String

Método de solicitud, que puede ser:

  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY

CRU

req_uri

String

Dirección de acceso (URI) del backend de web

CRU

timeout

Integer

Duración del tiempo de espera en milisegundos. Alcance: 1–60,000.

CRU

front_api_id

String

ID de API

R

-

register_time

Timestamp

Tiempo de creación

R

-

update_time

Timestamp

Hora en la que se modificó por última vez el backend de web

R

-

remark

String

Descripción del backend de web

CRU

No

vpc_status

Integer

Indica si se debe utilizar un canal de VPC. El valor puede ser:

  • 1: sí
  • 2: no

CRU

No. No se utiliza ningún canal de VPC por defecto.

vpc_info

String

Información del canal de VPC

CRU

No

Este parámetro solo es necesario cuando vpc_status se establece en 1.

authorizer_id

String

ID del autorizador personalizado de backend

CRU

No

Tabla 3 Mock backend object model

Parámetro

Tipo

Descripción

Tipo de operación

Obligatorio

id

String

ID de backend de simulacro

R

-

front_api_id

String

ID de API

R

-

status

Integer

Estado del backend de simulacro, que puede ser:

  • 1: enabled
  • 2: disabled
  • 3: deleted

Valor predeterminado: 1

Este parámetro no se utiliza actualmente.

R

-

version

String

Versión del backend de simulacro

CRU

No

result_content

String

Respuesta de simulacro

CRU

No

register_time

Timestamp

Tiempo de creación

R

-

update_time

Timestamp

Hora en la que el backend de simulacro fue modificado por última vez

R

-

remark

String

Descripción del backend de simulacro

CRU

No

Tabla 4 FunctionGraph backend object model

Parámetro

Tipo

Descripción

Tipo de operación

Obligatorio

id

String

ID de la función

R

-

front_api_id

String

ID de API

R

-

status

Integer

Estado de la función, que puede ser:

  • 1: enabled
  • 2: disabled
  • 3: deleted

Valor predeterminado: 1

Este parámetro no se utiliza actualmente.

R

-

version

String

Versión de la función

CRU

No

function_urn

String

Función URN

CRU

invocation_type

String

Modo de invocación, que puede ser async o sync

CRU

timeout

Integer

Duración del tiempo de espera en milisegundos. Alcance: 1–60,000.

CRU

register_time

Date

Tiempo de creación

R

-

update_time

Date

Hora en la que la función fue modificada por última vez

R

-

remark

String

Descripción de la función

CRU

No

Tabla 5 Request parameter object model

Parámetro

Tipo

Descripción

Tipo de operación

Obligatorio

id

String

ID del parámetro

R

-

front_api_id

String

ID de API

R

-

name

String

Nombre del parámetro

CRU

Yes

type

String

Tipo de parámetro, que puede ser:

  • string
  • number

CRU

Yes

location

String

Ubicación del parámetro, que puede ser:

  • PATH
  • QUERY
  • HEADER
  • FORMDATA

CRU

default_value

String

Valor predeterminado

CRU

No

sample_value

String

Valor de ejemplo

CRU

No

required

Integer

Si el parámetro es obligatorio

  • 1: sí
  • 2: no

CRU

valid_enable

Integer

Si la comprobación de validez está activada

  • 1: sí
  • 2: no

CRU

remark

String

Descripción de parámetro

CRU

No

enumerations

String

Valor enumerado

CRU

No

min_num

String

Valor mínimo

CRU

No

max_num

String

Valor máximo

CRU

No

min_size

Integer

Longitud mínima

CRU

No

max_size

Integer

Longitud máxima

CRU

No

regular

String

Regla de verificación regular (actualmente no soportada)

CRU

No

json_schema

String

Regla de verificación de JSON (actualmente no soportada)

CRU

No

Tabla 6 Backend parameter object model

Parámetro

Tipo

Descripción

Tipo de operación

Obligatorio

id

String

ID del parámetro

R

-

front_api_id

String

ID de API

R

-

req_param_id

String

ID del parámetro de solicitud al que se asigna el parámetro de backend

R

-

name

String

Nombre del parámetro

CRU

location

String

Ubicación del parámetro, que puede ser:

  • PATH
  • QUERY
  • HEADER
  • FORMDATA

CRU

origin

String

Tipo de parámetro, que puede ser:

  • REQUEST
  • CONSTANT
  • SYSTEM

CRU

value

String

Valor del parámetro

  • Si origin se establece en REQUEST, el valor es el nombre del parámetro de solicitud.
  • Si origin se establece en SYSTEM el valor es el nombre del parámetro de gateway.
  • Si origin se establece en CONSTANT, el valor es el valor real del parámetro backend.

CRU

No

remark

String

Descripción de parámetro

CRU

No

policy_id

String

ID de la condición de política asociada

CRU

No

Tabla 7 Web backend policy object model

Parámetro

Tipo

Descripción

Tipo de operación

Obligatorio

id

String

ID de backend

R

-

front_api_id

String

ID de API

R

-

name

String

Nombre de backend

CRU

url_domain

String

Punto de conexión de backend

CRU

req_protocol

String

Protocolo de solicitud, que puede ser:

  • HTTP
  • HTTPS

CRU

req_method

String

Método de solicitud, que puede ser:

  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • PATCH
  • OPTIONS
  • ANY

CRU

req_uri

String

Dirección de acceso (URI) del backend de web

CRU

timeout

Integer

Duración del tiempo de espera en milisegundos. Alcance: 1–60,000.

CRU

No

vpc_status

Integer

Indica si se debe utilizar un canal de VPC. El valor puede ser:

  • 1: sí
  • 2: no

CRU

No. No se utiliza ningún canal de VPC por defecto.

vpc_info

String

Información del canal de VPC

CRU

No

Este parámetro solo es necesario cuando vpc_status se establece en 1.

effect_mode

String

Modo efectivo de la política de backend

  • ALL
  • ANY

CRU

Tabla 8 Mock backend policy object model

Parámetro

Tipo

Descripción

Tipo de operación

Obligatorio

id

String

ID de backend

R

-

front_api_id

String

ID de API

R

-

name

String

Nombre de backend

CRU

result_content

String

Respuesta de simulacro

CRU

No

effect_mode

String

Modo efectivo de la política de backend

  • ALL
  • ANY

CRU

Tabla 9 FunctionGraph policy backend object model

Parámetro

Tipo

Descripción

Tipo de operación

Obligatorio

id

String

ID de backend

R

-

front_api_id

String

ID de API

R

-

name

String

Nombre de backend

CRU

version

String

Versión de la función

CRU

No

function_urn

String

Función URN

CRU

invocation_type

String

Invocation mode, which can be async or sync

CRU

Yes

timeout

Integer

Duración del tiempo de espera en milisegundos. Alcance: 1–60,000.

CRU

effect_mode

String

Modo efectivo de la política de backend

  • ALL
  • ANY

CRU

Tabla 10 Backend policy condition object model

Parámetro

Tipo

Descripción

Tipo de operación

Obligatorio

id

String

ID de condición de política de backend

R

-

condition_type

String

Tipo de condición. Opciones:

  • exact: Coincidencia exacta
  • enum: Enumeración
  • pattern: expresión regular

CRU

No

condition_value

String

Valor de la condición

CRU

condition_origin

String

Fuente de condición. Opciones:

  • param: parámetro de entrada
  • source: Dirección IP de origen

CRU

req_param_id

String

ID de parámetro de entrada

R

-

policy_backend_id

String

ID de política de backend

CRU

Tabla 11 Authentication mode parameter object model

Parámetro

Tipo

Descripción

Tipo de operación

Obligatorio

app_code_auth_type

String

Indica si la autenticación AppCode está habilitada. Este parámetro solo es válido cuando auth_type está establecido en App. El valor predeterminado es DISABLE.

  • DISABLE: La autenticación de AppCode está deshabilitada.
  • HEADER: La autenticación de AppCode está habilitada y el AppCode se encuentra en el encabezado.

CRU

-

Utilizamos cookies para mejorar nuestro sitio y tu experiencia. Al continuar navegando en nuestro sitio, tú aceptas nuestra política de cookies. Descubre más

Comentarios

Comentarios

Comentarios

0/500

Seleccionar contenido

Enviar el contenido seleccionado con los comentarios