Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda/ API Gateway/ Referência de API/ APIs compartilhadas de gateway (para usuários existentes)/ Gerenciamento de API/ Publicação de várias APIs ou colocação de várias APIs off-line

Atualizado em 2023-05-29 GMT+08:00

Ver PDF

Publicação de várias APIs ou colocação de várias APIs off-line

Função

Esta API é usada para publicar várias APIs em um ambiente ou para remover várias APIs do ambiente em que foram publicadas.

URI

A tabela a seguir lista o método de solicitação HTTP/HTTPS e o URI da API.

**Tabela 1** Método de solicitação HTTP/HTTPS e URI
Método de solicitação	URI
POST	/v1.0/apigw/apis/publish[?action]

A tabela a seguir lista o parâmetro no URI.

**Tabela 2** Descrição do parâmetro
Parâmetro	Obrigatório	Tipo	Descrição
action	Não	String	online: publicar offline: ficar off-line

Solicitação

**Tabela 3** Descrição do parâmetro
Parâmetro	Obrigatório	Tipo	Descrição
apis	Sim	String Array	IDs das APIs a serem publicadas ou colocadas off-line
env_id	Sim	String	ID do ambiente
remark	Não	String	Descrição da publicação A descrição não pode exceder 255 caracteres.

Exemplo de solicitação:

{
	"apis": ["81efcfd94b8747a0b21e8c04144a4e8c","7addcd00cfab433984b1d8bf2fe08aaa"],
	"env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
  "remark": "Published in the production environment"
}

Resposta

**Tabela 4** Descrição do parâmetro
Parâmetro	Tipo	Descrição
success	Array	Mensagem para publicação bem-sucedida da API ou colocação off-line
failure	Array	Mensagem de erro e APIs que não conseguem ser publicadas ou colocadas offline

**Tabela 5** Descrição do parâmetro de sucesso (publicação em lote)
Parâmetro	Tipo	Descrição
publish_id	String	ID do registro da publicação
api_id	String	ID de uma API publicada com sucesso
api_name	String	Nome da API
env_id	String	ID do ambiente no qual a API foi publicada
remark	String	Descrição da publicação
publish_time	Timestamp	Hora em que a API é publicada
version_id	String	Versão da API

**Tabela 6** Descrição do parâmetro de sucesso (mantendo off-line em lotes)
Parâmetro	Tipo	Descrição
api_id	String	ID de uma API que é colocada off-line com sucesso
api_name	String	Nome da API

**Tabela 7** Descrição do parâmetro da falha
Parâmetro	Tipo	Descrição
api_id	String	ID de uma API que não consegue ser publicada ou colocada off-line
api_name	String	Nome da API
error_code	String	Código de erro
error_msg	String	Mensagem de erro

Exemplo de resposta:

{
	"success": [{
		"publish_id": "5b729aa252764739be2c37ef0d66dc63",
		"api_id": "7addcd00cfab433984b1d8bf2fe08aaa",
                "api_name": "testApi",
		"env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
		"version_id": "3d9dcb733ba34352b0d02f85fd16b026",
		"remark": "string",
		"publish_time": "2018-07-26T13:18:04.1079916Z"
	}],
	"failure": [{
		"api_id": "81efcfd94b8747a0b21e8c04144a4e8c",
		"error_code": "APIG.3002",
		"error_msg": "api with id 81efcfd94b8747a0b21e8c04144a4e8c not found"
	}]
}