Vinculação de uma política de controle de acesso a uma API
Função
Esta API é usada para vincular uma política de controle de acesso a uma API especificada.
Você pode vincular diferentes políticas de controle de acesso a uma API em diferentes ambientes, mas pode vincular apenas uma política de controle de acesso à API em cada ambiente.
URI
POST /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings
|
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 |
|---|---|---|---|
|
acl_id |
Não |
String |
ID da política de controle de acesso. |
|
publish_ids |
Não |
Array of strings |
ID do registro de publicação da API. |
Parâmetros de resposta
Código de status: 201
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
acl_bindings |
Array of AclApiBindingInfo objects |
Registros de vinculação de política de controle de acesso. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
id |
String |
Vinculação de ID do registro. |
|
api_id |
String |
ID da API. |
|
env_id |
String |
ID do ambiente. |
|
acl_id |
String |
ID da política de controle de acesso. |
|
create_time |
String |
Tempo de vinculaçã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: 404
|
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
{
"acl_id" : "7eb619ecf2a24943b099833cd24a01ba",
"publish_ids" : [ "40e7162dc6b94bbbbb1a60d2a24b1b0c" ]
}
Exemplo de respostas
Código de status: 201
Criado
{
"acl_bindings" : [ {
"id" : "332c5db1458a477b89b2ea741fec94a3",
"api_id" : "5f918d104dc84480a75166ba99efff21",
"env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
"acl_id" : "7eb619ecf2a24943b099833cd24a01ba",
"create_time" : "2020-08-04T08:58:03.001228747Z"
} ]
}
Código de status: 400
Solicitação inválida
{
"error_code" : "APIG.2011",
"error_msg" : "Invalid parameter value,parameterName:acl_id. 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: 404
Não encontrado
{
"error_code" : "APIG.3006",
"error_msg" : "Access control policy 7eb619ecf2a24943b099833cd24a01ba does not exist"
}
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 |
|
404 |
Não encontrado |
|
500 |
Erro do servidor interno |
Códigos de erro
Consulte Códigos de erro.
