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

Nota

Esta operação aplica-se apenas a instâncias por assinatura.

Depuração

Chame esta operação no OpenAPI Explorer para evitar o cálculo manual de assinaturas. Após a execução bem-sucedida, o OpenAPI Explorer gera automaticamente um código de exemplo para o kit de desenvolvimento de software (SDK).

Parâmetros da solicitação

Nome	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeInstanceAutoRenewalAttribute	Parâmetro obrigatório. Defina o valor como DescribeInstanceAutoRenewalAttribute.
RegionId	String	Sim	cn-hangzhou	ID da região da instância. Chame a operação DescribeDBInstanceAttribute para consultar o ID da região.
DBInstanceId	String	Não	dds-bp567b****	ID da instância.
DBInstanceType	String	Não	replicate	Tipo da instância. Valores válidos: replicate (padrão): instância de nó único ou conjunto de réplicas. sharding: instância de cluster com sharding.
PageSize	Long	Não	30	Número de registros a serem retornados em cada página. Valores válidos: 30 (padrão), 50 e 100.
PageNumber	Long	Não	1	Número da página. O valor deve ser um número inteiro positivo que não exceda o valor máximo do tipo de dados Integer. Valor padrão: 1.

Dados retornados

Nome	Tipo	Exemplo	Descrição
ItemsNumbers	Integer	2	Número total de registros retornados.
PageRecordCount	Integer	2	Quantidade de registros retornados na página atual.
RequestId	String	FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949	ID da solicitação.
PageNumber	Integer	1	Número da página.
Items	Array of Item		Lista de resultados da consulta.
Item
DBInstanceType	String	replicate	Tipo da instância. Valores possíveis: replicate: instância de nó único ou conjunto de réplicas. sharding: instância de cluster com sharding.
AutoRenew	String	true	Status da renovação automática. Valores possíveis: true: renovação automática ativada. false: renovação automática desativada.
Duration	String	1	Período de renovação automática. Unidade: mês. Nota Este parâmetro é retornado somente quando o valor do parâmetro AutoRenew for true. Para alterar o período de renovação automática, chame a operação ModifyInstanceAutoRenewalAttribute.
DbInstanceId	String	dds-bp2568*****	ID da instância.
RegionId	String	cn-hangzhou	ID da região.

Exemplos

Exemplo de solicitação

http(s)://mongodb.aliyuncs.com/?Action=DescribeInstanceAutoRenewalAttribute
&RegionId=cn-hangzhou
&DBInstanceId=dds-bp567b****
&DBInstanceType=replicate
&PageSize=30
&PageNumber=1
&<Common request parameters>

Exemplos de resposta

Formato XML

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

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeInstanceAutoRenewalAttributeResponse>
	<Items>
		<Item>
			<DBInstanceType>replicate</DBInstanceType>
			<RegionId>cn-hangzhou</RegionId>
			<DbInstanceId>dds-bpxxxxxxxx</DbInstanceId>
			<AutoRenew>false</AutoRenew>
		</Item>
		<Item>
			<DBInstanceType>replicate</DBInstanceType>
			<Duration>1</Duration>
			<RegionId>cn-hangzhou</RegionId>
			<DbInstanceId>dds-bpxxxxxxxx</DbInstanceId>
			<AutoRenew>true</AutoRenew>
		</Item>
	</Items>
	<PageNumber>1</PageNumber>
	<RequestId>FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949</RequestId>
	<ItemsNumbers>2</ItemsNumbers>
	<PageRecordCount>2</PageRecordCount>
</DescribeInstanceAutoRenewalAttributeResponse>

Formato JSON

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

{
  "Items" : {
    "Item" : [ {
      "DBInstanceType" : "replicate",
      "RegionId" : "cn-hangzhou",
      "DbInstanceId" : "dds-bpxxxxxxxx",
      "AutoRenew" : "false"
    }, {
      "DBInstanceType" : "replicate",
      "Duration" : 1,
      "RegionId" : "cn-hangzhou",
      "DbInstanceId" : "dds-bpxxxxxxxx",
      "AutoRenew" : "true"
    } ]
  },
  "PageNumber" : 1,
  "RequestId" : "FAB5CB3B-DB9D-473A-9DF1-F57B6B9CB949",
  "ItemsNumbers" : 2,
  "PageRecordCount" : 2
}

Códigos de erro

Para obter uma lista de códigos de erro, consulte o Error Center.