DescribeSecurityIPGroup - Database Autonomy Service: Central de Documentação do Alibaba Cloud

Visualiza os detalhes de um modelo de whitelist entre produtos.

Descrição da operação

Observe o seguinte antes de chamar esta operação:

Use a versão mais recente do kit de desenvolvimento de software (SDK) da Alibaba Cloud ou do SDK do DAS.
Ao usar um SDK para chamar o DAS Service, defina a região como cn-shanghai.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

hdm:DescribeSecurityIPGroup

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionName	string	Sim	O ID da região.	cn-shanghai

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O esquema de resposta.
Code	string	O código de status retornado.	200
Data	object	ListResult.
SecurityIpGroups	array<object>	Uma lista de todos os modelos de whitelist entre produtos na região especificada.
	array<object>
DbInstances	array	The database instances that are attached to the whitelist template.
	string	The database instance ID.	["r-2ze9g6mnhu1*", "pc-2zew5qn1m", "r-2ze9g6mn*", "pc-2zew5qh41***"]
SecurityIpType	string	The IP address type.	ipv4
Uid	string	The account ID. You can obtain the ID of your logon account on the Security Settings page of Account Management.	160-79abe3f4****
RegionId	string	The region ID.	cn-hangzhou
GEcsSgIdList	string	The ID of the ECS security group. This parameter is deprecated and is retained for compatibility. It will be removed in a future version.	null
GlobalIgName	string	The name of the IP address whitelist template. The name must meet the following requirements: It must consist of lowercase letters, digits, and underscores (_). It must start with a letter and end with a letter or a digit. It must be 2 to 120 characters in length.	test_123
GlobalSecurityGroupId	string	The ID of the IP address whitelist template.	g-1no2rzybnqcv****
WhitelistNetType	string	The network type of the whitelist.	mix
EngineInfoList	array<object>	The information about the instances of each product that are attached to the template.
	object
InstanceNum	integer	The number of instances that belong to the current logon account.	10
EngineName	string	The database type of the destination instance.	PolarDBMySQL
InstanceIds	array	A list of database instance IDs.
	string	The database instance ID. Nota The value is a JSON array, such as `['Instance ID1','Instance ID2']`. Separate multiple instance IDs with commas (,).	rm-2ze8ygcc****
UserId	string	The user ID.	641***
GIpList	string	The IP addresses in the whitelist template. Nota Separate multiple IP addresses with commas (,).	192.168.1.28/32
Message	string	A mensagem retornada para a solicitação. Nota Se a solicitação for bem-sucedida, Successful será retornado. Se a solicitação falhar, uma mensagem de erro será retornada, como um código de erro.	Successful
RequestId	string	O ID da solicitação.	CAC553F1-C669-53F1-A295-2CF050E****
Success	string	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Data": {
    "SecurityIpGroups": [
      {
        "DbInstances": [
          "[\"r-2ze9g6mnhu1***\",\n\"pc-2zew5qn1m***\",\n\"r-2ze9g6mn****\",\n\"pc-2zew5qh41*****\"]"
        ],
        "SecurityIpType": "ipv4",
        "Uid": "160-79abe3f4****",
        "RegionId": "cn-hangzhou",
        "GEcsSgIdList": " null",
        "GlobalIgName": "test_123",
        "GlobalSecurityGroupId": "g-1no2rzybnqcv****",
        "WhitelistNetType": "mix",
        "EngineInfoList": [
          {
            "InstanceNum": 10,
            "EngineName": "PolarDBMySQL",
            "InstanceIds": [
              "rm-2ze8ygcc****"
            ]
          }
        ],
        "UserId": "641***",
        "GIpList": "192.168.1.28/32"
      }
    ]
  },
  "Message": "Successful",
  "RequestId": "CAC553F1-C669-53F1-A295-2CF050E****",
  "Success": "true"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.