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

Creación de un grupo de API

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

Función

Esta API se utiliza para crear un grupo de API. Un grupo de API es una unidad de gestión de API y la entrada a un servicio. Cuando se crea un grupo API, se devuelve un nombre de subdominio como entrada de acceso. Las API de un grupo de API deben estar correlacionadas entre sí.

URI

POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups

Tabla 1 Parámetros de path

Parámetro

Obligatorio

Tipo

Descripción

project_id

String

ID del proyecto. Para obtener detalles sobre cómo obtener un ID de proyecto, consulte "Apéndice" > "Obtención de un ID de proyecto" en este documento.

instance_id

String

Gateway ID, que se puede obtener de la información de gateway en la consola APIG.

Parámetros de solicitud

Tabla 2 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

String

Token de usuario. Se puede obtener llamando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es un token.

Tabla 3 Parámetros de body de solicitud

Parámetro

Obligatorio

Tipo

Descripción

name

String

Nombre del grupo API.

El valor puede contener de 3 a 255 caracteres, incluidas letras, dígitos y caracteres especiales (-_./():). Debe comenzar con una letra o un dígito.

Mínimo: 3

Máximo: 255

remark

No

String

Descripción del grupo API.

Máximo: 1000

roma_app_id

No

String

ID de la aplicación de integración a la que pertenece el grupo API.

Este parámetro es necesario cuando la versión de grupo es V2.

Actualmente, este parámetro no es compatible.

version

No

String

Versión de grupo.

  • V1: grupo global
  • V2: grupo de nivel de aplicación

El valor predeterminado es V1. Este parámetro no se admite actualmente.

Parámetros de respuesta

Código de estado: 201

Tabla 4 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

id

String

ID.

name

String

Nombre del grupo API.

status

Integer

Estado.

  • 1: válido

Valores de enumeración:

  • 1

sl_domain

String

Nombre de subdominio que APIG asigna automáticamente al grupo de API.

register_time

String

Hora de creación.

update_time

String

Hora de la última modificación.

on_sell_status

Integer

Indica si el grupo de API aparece en la lista KooGallery.

  • 1: listed
  • 2: not listed
  • 3: under review

url_domains

Array of UrlDomain objects

Nombres de dominio independientes enlazados al grupo API.

sl_domains

Array of strings

Nombres de subdominio asignados automáticamente.

remark

String

Descripción.

call_limits

Integer

Número total de veces que se puede acceder a todas las API del grupo de API. Tenga en cuenta la capacidad de carga útil del servicio de backend al establecer este parámetro. De forma predeterminada, no hay límite en el número de llamadas a la API.

Actualmente, este parámetro no es compatible.

time_interval

Integer

Período de tiempo para limitar el número de llamadas a la API.

Actualmente, este parámetro no es compatible.

time_unit

String

Unidad de tiempo para limitar el número de llamadas API.

Actualmente, este parámetro no es compatible.

is_default

Integer

Indica si el grupo API es el grupo predeterminado.

version

String

Versión de grupo.

  • V1: grupo global
  • V2: grupo de nivel de aplicación

El valor predeterminado es V1. Este parámetro no se admite actualmente.

roma_app_id

String

ID de la aplicación de integración a la que pertenece el grupo API.

Este parámetro es necesario cuando la versión de grupo es V2.

Actualmente, este parámetro no es compatible.

roma_app_name

String

Nombre de la aplicación de integración a la que pertenece el grupo API.

Actualmente, este parámetro no es compatible.

Tabla 5 UrlDomain

Parámetro

Tipo

Descripción

id

String

ID de dominio.

domain

String

Nombre de dominio.

cname_status

Integer

Estado de resolución CNAME del nombre de dominio.

  • 1: not resolved
  • 2: resolving
  • 3: resolved
  • 4: resolution failed

ssl_id

String

ID de certificado SSL.

ssl_name

String

Nombre del certificado SSL.

min_ssl_version

String

Versión mínima de SSL. Se admiten TLS 1.1 y TLS 1.2.

Predeterminado: TLSv1.1

Valores de enumeración:

  • TLSv1.1
  • TLSv1.2

Código de estado: 400

Tabla 6 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 401

Tabla 7 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 403

Tabla 8 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 500

Tabla 9 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Solicitudes de ejemplo

{
  "name" : "api_group_001",
  "remark" : "API group 1"
}

Ejemplo de respuestas

Código de estado: 201

Created

{
  "update_time" : "2020-07-31T06:55:55.383169299Z",
  "name" : "api_group_001",
  "on_sell_status" : 2,
  "remark" : "API group 1",
  "sl_domains" : [ "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com", "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.cn" ],
  "sl_domain" : "c77f5e81d9cb4424bf704ef2b0ac7600.apic.****.com",
  "id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
  "register_time" : "2020-07-31T06:55:55.383169068Z",
  "status" : 1,
  "is_default" : 2
}

Código de estado: 400

Bad Request

{
  "error_code" : "APIG.2011",
  "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}

Código de estado: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Código de estado: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Código de estado: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Códigos de estado

Código de estado

Descripción

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Códigos de error

Consulte Códigos de error.

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