Criação de um grupo de API
Função
Esta API é usada para criar um grupo da API. Um grupo da API é uma unidade de gerenciamento de API e a entrada para um serviço. Um nome de subdomínio é retornado como a entrada de acesso quando um grupo da API é criado. As APIs em um grupo da API devem ser correlacionadas entre si.
URI
POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| project_id | Sim | String | ID do projeto. Para obter detalhes sobre como obter um ID de projeto, consulte "Apêndice" > "Obtenção de um ID de projeto" neste documento. |
| instance_id | Sim | String | ID do gateway, que pode ser obtido a partir das informações de gateway no console do APIG. |
Parâmetros de solicitação
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| X-Auth-Token | Sim | String | Token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é um token. |
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| name | Sim | String | Nome do grupo de APIs. O valor pode conter de 3 a 255 caracteres, incluindo letras, dígitos e caracteres especiais (-_./():). Deve começar com uma letra ou dígito. Mínimo: 3 Máximo: 255 |
| remark | Não | String | Descrição do grupo de API. Máximo: 1000 |
| roma_app_id | Não | String | ID da aplicação de integração ao qual o grupo de APIs pertence. Este parâmetro é necessário quando a versão do grupo é V2. Atualmente, este parâmetro não é suportado. |
| version | Não | String | Versão do grupo.
O valor padrão é V1. Este parâmetro não é suportado atualmente. |
Parâmetros de resposta
Código de status: 201
| Parâmetro | Tipo | Descrição |
|---|---|---|
| id | String | ID. |
| name | String | Nome do grupo de APIs. |
| status | Integer | Status.
Valores de enumeração:
|
| sl_domain | String | Nome do subdomínio que o APIG aloca automaticamente ao grupo da API. |
| register_time | String | Tempo de criação. |
| update_time | String | Hora da última modificação. |
| on_sell_status | Integer | Indica se o grupo de APIs foi listado no KooGallery.
|
| url_domains | Array of UrlDomain objects | Nomes de domínio independentes vinculados ao grupo de APIs. |
| sl_domains | Array of strings | Nomes de subdomínio alocados automaticamente. |
| remark | String | Descrição. |
| call_limits | Integer | Número total de vezes que todas as APIs no grupo da API podem ser acessadas. Considere a capacidade de carga útil do serviço de back-end ao definir esse parâmetro. Por padrão, não há limite no número de chamadas de API. Atualmente, este parâmetro não é suportado. |
| time_interval | Integer | Período de tempo para limitar o número de chamadas de API. Atualmente, este parâmetro não é suportado. |
| time_unit | String | Unidade de tempo para limitar o número de chamadas de API. Atualmente, este parâmetro não é suportado. |
| is_default | Integer | Indica se o grupo de API é o grupo padrão. |
| version | String | Versão do grupo.
O valor padrão é V1. Este parâmetro não é suportado atualmente. |
| roma_app_id | String | ID da aplicação de integração ao qual o grupo de APIs pertence. Este parâmetro é necessário quando a versão do grupo é V2. Atualmente, este parâmetro não é suportado. |
| roma_app_name | String | Nome da aplicação de integração ao qual o grupo de APIs pertence. Atualmente, este parâmetro não é suportado. |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| id | String | ID do domínio. |
| domain | String | Nome de domínio. |
| cname_status | Integer | Status de resolução CNAME do nome de domínio.
|
| ssl_id | String | ID do certificado SSL. |
| ssl_name | String | Nome do certificado SSL. |
| min_ssl_version | String | Versão SSL mínima. TLS 1.1 e TLS 1.2 são suportados. Padrão: TLSv1.1 Valores de enumeração:
|
Código de status: 400
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_code | String | Código de erro. |
| error_msg | String | Mensagem de erro. |
Código de status: 401
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_code | String | Código de erro. |
| error_msg | String | Mensagem de erro. |
Código de status: 403
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_code | String | Código de erro. |
| error_msg | String | Mensagem de erro. |
Código de status: 500
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_code | String | Código de erro. |
| error_msg | String | Mensagem de erro. |
Exemplo de solicitações
{
"name" : "api_group_001",
"remark" : "API group 1"
} Exemplo de respostas
Código de status: 201
Criado
{
"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 status: 400
Solicitação inválida
{
"error_code" : "APIG.2011",
"error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
} Código de status: 401
Não autorizado
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
} Código de status: 403
Proibido
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
} Código de status: 500
Erro do servidor interno
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
} Códigos de status
| Código de status | Descrição |
|---|---|
| 201 | Criado |
| 400 | Solicitação inválida |
| 401 | Não autorizado |
| 403 | Proibido |
| 500 | Erro do servidor interno |
Códigos de erro
Consulte Códigos de erro.
