ListPublicIpAddressPools - : Central de Documentação do Alibaba Cloud

Consulta os pools de endereços IP disponíveis.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListPublicIpAddressPools	A operação a ser executada. Defina o valor como ListPublicIpAddressPools.
PublicIpAddressPoolIds.N	String	Não	pippool-6wetvn6fumkgycssx****	Os IDs dos pools de endereços IP. É possível inserir até 100 IDs.
Status	String	Não	Created	O status do pool de endereços IP. Valores válidos: Created Deleting Modifying
MaxResults	Integer	Não	10	O número máximo de entradas a retornar. Valores válidos: 10 a 100. Valor padrão: 10.
NextToken	String	Não	FFmyTO70tTpLG6I3FmYAXGKPd****	O token de paginação usado na próxima solicitação para recuperar uma nova página de resultados. Valores válidos: Não é necessário especificar este parâmetro na primeira solicitação. Especifique o token obtido na consulta anterior como o valor de NextToken.
Isp	String	Não	BGP	O tipo de linha. Valores válidos: BGP (padrão) BGP_PRO Para obter mais informações sobre BGP (Multi-ISP) e BGP (Multi-ISP) Pro, consulte Tipos de linha. Se você tiver permissão para usar largura de banda de ISP único, também poderá usar um dos seguintes valores: ChinaTelecom ChinaUnicom ChinaMobile ChinaTelecom_L2 ChinaUnicom_L2 ChinaMobile_L2 Se seus serviços estiverem implantados na China East 1 Finance, este parâmetro será obrigatório e você deverá definir o valor como BGP_FinanceCloud.
Name	String	Não	AddressPoolName	O nome do pool de endereços IP. Este parâmetro é opcional. O nome deve ter de 1 a 128 caracteres e pode conter dígitos, pontos (.), sublinhados (_) e hifens (-). O nome deve começar com uma letra, mas não pode iniciar com `http://` ou `https://`.
DryRun	Boolean	Não	false	Especifica se deve ser executada apenas uma simulação, sem realizar a solicitação real. Valores válidos: true: executa apenas uma simulação. O sistema verifica a solicitação em busca de possíveis problemas, incluindo valores de parâmetros ausentes, sintaxe incorreta e limites de serviço. Se a solicitação falhar na simulação, um código de erro será retornado. Caso contrário, o código de erro `DryRunOperation` será retornado. false (padrão): executa uma simulação e realiza a solicitação real. Se a solicitação passar na simulação, um código de status HTTP 2xx será retornado e a operação será executada.
ResourceGroupId	String	Não	rg-acfmxazb4pcdvf****	O ID do grupo de recursos ao qual o pool de endereços IP pertence.
Tags.N.Key	String	Não	FinanceDept	A chave da tag N a ser adicionada ao recurso. É possível especificar no máximo 20 chaves de tag. A chave da tag não pode ser uma string vazia. A chave da tag pode ter no máximo 128 caracteres. Ela não pode começar com `aliyun` ou `acs:`, e não pode conter `http://` ou `https://`.
Tags.N.Value	String	Não	FinanceJoshua	O valor da tag N a ser adicionada ao recurso. É possível especificar no máximo 20 valores de tag. O valor da tag pode ser uma string vazia. O valor da tag pode ter até 128 caracteres e não pode começar com `acs:` ou `aliyun`. O valor da tag não pode conter `http://` ou `https://`.
RegionId	String	Sim	cn-chengdu	O ID da região onde consultar os pools de endereços IP. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	4EC47282-1B74-4534-BD0E-403F3EE64CAF	O ID da solicitação.
NextToken	String	FFmyTO70tTpLG6I3FmYAXGKPd****	Um token de paginação. Pode ser usado na próxima solicitação para recuperar uma nova página de resultados. Valores válidos: Se o valor de NextToken não for retornado, isso indica que nenhuma consulta subsequente deve ser enviada. Se um valor for retornado para NextToken, esse valor indica o token a ser usado na próxima consulta.
TotalCount	Integer	1	O número total de entradas retornadas.
PublicIpAddressPoolList	Array of PublicIpAddressPool		A lista de pools de endereços IP.
PublicIpAddressPoolId	String	pippool-6wetvn6fumkgycssx****	O ID do pool de endereços IP.
RegionId	String	cn-chengdu	O ID da região onde consultar os pools de endereços IP.
CreationTime	String	2022-05-10T01:37:38Z	O momento em que o pool de endereços IP foi criado. O horário é exibido no formato `YYYY-MM-DDThh:mm:ssZ`.
Isp	String	BGP	O tipo de linha. Valores válidos: BGP BGP_PRO Para obter mais informações sobre BGP (Multi-ISP) e BGP (Multi-ISP) Pro, consulte Tipos de linha. Se você tiver permissão para usar largura de banda de ISP único, um dos seguintes valores poderá ser retornado: ChinaTelecom ChinaUnicom ChinaMobile ChinaTelecom_L2 ChinaUnicom_L2 ChinaMobile_L2 Se seus serviços estiverem implantados na China East 1 Finance, BGP_FinanceCloud será retornado.
Name	String	AddressPoolName	O nome do pool de endereços IP.
Status	String	Created	O status do pool de endereços IP. Valores válidos: Created Deleting Modifying
Description	String	AddressPoolDescription	A descrição do pool de endereços IP.
TotalIpNum	Integer	100	O número total de endereços IP no pool de endereços IP públicos.
UsedIpNum	Integer	20	O número de endereços IP ocupados no pool de endereços IP públicos.
IpAddressRemaining	Boolean	true	Indica se o pool de endereços IP possui endereços IP ociosos. Valores válidos: true false
UserType	Boolean	admin	O tipo de usuário. Valores válidos: admin: administrador. Um administrador pode excluir, modificar e consultar pools de endereços IP, além de alocar Elastic IP Addresses (EIPs) nesses pools. user: usuário comum. Um usuário comum pode apenas alocar EIPs em pools de endereços IP e consultá-los. Usuários comuns não podem modificar ou excluir pools de endereços IP.
OwnerId	Long	121012345612****	A conta Alibaba Cloud à qual o pool de endereços IP pertence.
ShareType	String	Shared	Indica se o pool de endereços IP é compartilhado. Apenas Shared pode ser retornado. Um valor vazio indica que o pool de endereços IP não é compartilhado.
ResourceGroupId	String	rg-acfmxazb4pcdvf****	O ID do grupo de recursos ao qual o pool de endereços IP pertence.
Tags	Array of Tag		A lista de tags.
Key	String	FinanceDept	A chave da tag N adicionada ao recurso.
Value	String	FinanceDept	O valor da tag N adicionada ao recurso.
BizType	String	CloudBox	O tipo de serviço do pool de endereços IP. CloudBox Apenas usuários do Cloud Box podem selecionar este tipo. Default (padrão)
Zones	Array of String	ap-southeast-1-lzdvn-cb	A zona do pool de endereços IP. Este parâmetro é retornado apenas quando o tipo de serviço é CloudBox.

Exemplos

Solicitações de exemplo

http(s)://[Endpoint]/?Action=ListPublicIpAddressPools
&PublicIpAddressPoolIds=["pippool-6wetvn6fumkgycssx****"]
&Status=Created
&MaxResults=10
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&Isp=BGP
&Name=AddressPoolName
&DryRun=false
&ResourceGroupId=rg-acfmxazb4pcdvf****
&Tags=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&RegionId=cn-chengdu
&Common request parameters

Respostas de sucesso de exemplo

XML formato

HTTP/1.1 200 OK
Content-Type:application/xml

<ListPublicIpAddressPoolsResponse>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <TotalCount>1</TotalCount>
    <PublicIpAddressPoolList>
        <PublicIpAddressPoolId>pippool-6wetvn6fumkgycssx****</PublicIpAddressPoolId>
        <RegionId>cn-chengdu</RegionId>
        <CreationTime>2022-05-10T01:37:38Z</CreationTime>
        <Isp>BGP</Isp>
        <Name>AddressPoolName</Name>
        <Status>Created</Status>
        <Description>AddressPoolDescription</Description>
        <TotalIpNum>100</TotalIpNum>
        <UsedIpNum>20</UsedIpNum>
        <IpAddressRemaining>true</IpAddressRemaining>
        <UserType>false</UserType>
        <ShareType>Shared</ShareType>
        <ResourceGroupId>rg-acfmxazb4pcdvf****</ResourceGroupId>
        <Tags>
            <Key>FinanceDept</Key>
            <Value>FinanceDept</Value>
        </Tags>
        <BizType>CloudBox</BizType>
        <Zones>ap-southeast-1-lzdvn-cb</Zones>
    </PublicIpAddressPoolList>
</ListPublicIpAddressPoolsResponse>

JSON formato

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount" : 1,
  "PublicIpAddressPoolList" : [ {
    "PublicIpAddressPoolId" : "pippool-6wetvn6fumkgycssx****",
    "RegionId" : "cn-chengdu",
    "CreationTime" : "2022-05-10T01:37:38Z",
    "Isp" : "BGP",
    "Name" : "AddressPoolName",
    "Status" : "Created",
    "Description" : "AddressPoolDescription",
    "TotalIpNum" : 100,
    "UsedIpNum" : 20,
    "IpAddressRemaining" : true,
    "UserType" : false,
    "ShareType" : "Shared",
    "ResourceGroupId" : "rg-acfmxazb4pcdvf****",
    "Tags" : [ {
      "Key" : "FinanceDept",
      "Value" : "FinanceDept"
    } ],
    "BizType" : "CloudBox",
    "Zones" : [ "ap-southeast-1-lzdvn-cb" ]
  } ]
}

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.