Todos os produtos
Search
Central de documentação

Resource Orchestration Service:DATASOURCE::GraphDatabase::DbInstance

Última atualização: Jun 27, 2026

Consulta os detalhes de uma instância do Graph Database (GDB).

Sintaxe

{
  "Type": "DATASOURCE::GraphDatabase::DbInstance",
  "Properties": {
    "DbInstanceId": String,
    "RefreshOptions": String
  }
}

Propriedades

Propriedade

Tipo

Obrigatória

Editável

Descrição

Restrição

DbInstanceId

String

Sim

Sim

ID da instância.

Nenhuma.

RefreshOptions

String

Não

Sim

Política de atualização dos recursos da source de dados durante a atualização da pilha.

Valores válidos:

  • Never (padrão): não atualiza os recursos da source de dados durante a atualização da pilha.

  • Always: atualiza os recursos da source de dados durante a atualização da pilha.

Valores de retorno

Fn::GetAtt

  • ResourceGroupId: ID do grupo de recursos.

  • DbInstanceNetworkType: tipo de rede da instância.

  • Port: porta de acesso à aplicação.

  • DbInstanceType: tipo da instância.

  • DbInstanceStorageType: tipo de armazenamento da instância.

  • DbNodeStorage: espaço de armazenamento do banco de dados.

  • DbInstanceCategory: edição da instância.

  • DbVersion: versão do banco de dados.

  • CurrentMinorVersion: versão do kernel do banco de dados.

  • PaymentType: método de faturamento.

  • PublicConnectionString: prefixo do endpoint público para conexão com a instância.

  • DBInstanceId: ID da instância.

  • LockReason: motivo do bloqueio da instância.

  • DbNodeClass: tipo do nó.

  • MaintainTime: janela de manutenção da instância.

  • Tags: tags associadas à instância.

  • ZoneId: ID da zona da instância.

  • VSwitchId: ID do vSwitch da instância.

  • CreateTime: hora de criação da instância.

  • DbNodeCount: quantidade de nós.

  • LatestMinorVersion: versão mais recente do kernel compatível com a instância.

  • Expired: horário de expiração da instância.

  • EcsSecurityGroupRelations: grupos de segurança associados.

  • LockMode: modo de bloqueio da instância.

  • DbInstanceMemory: tamanho da memória da instância.

  • ReadOnlyDbInstanceIds: IDs das instâncias somente leitura.

  • VpcId: ID da Virtual Private Cloud (VPC) onde a instância está localizada.

  • DBInstanceIPArray: listas de permissões de endereços IP.

  • DbInstanceDescription: descrição da instância.

  • DbInstanceCpu: número de vCPUs da instância.

  • ConnectionString: endpoint para conexão com o banco de dados.

  • ExpireTime: horário de expiração do banco de dados.

  • PublicPort: porta pública para conexão com o banco de dados.

Exemplos

  • YAML formato

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      DbInstanceId:
        Type: String
        Description:
          en: The ID of the GDB Instance.
        Required: true
    Resources:
      ExtensionDataSource:
        Type: DATASOURCE::GraphDatabase::DbInstance
        Properties:
          DbInstanceId:
            Ref: DbInstanceId
    Outputs:
      ResourceGroupId:
        Description: Resource Group ID.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - ResourceGroupId
      DbInstanceNetworkType:
        Description: The network type of the db instance.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - DbInstanceNetworkType
      Port:
        Description: Application Port.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - Port
      DbInstanceType:
        Description: The type of the db instance.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - DbInstanceType
      DbInstanceStorageType:
        Description: Cloud Disk.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - DbInstanceStorageType
      DbNodeStorage:
        Description: Instance storage space, which is measured in GB.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - DbNodeStorage
      DbInstanceCategory:
        Description: The category of the db instance.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - DbInstanceCategory
      DbVersion:
        Description: Kernel Version 1.0 is represented as gremlin,1.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - DbVersion
      CurrentMinorVersion:
        Description: The current kernel image version.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - CurrentMinorVersion
      PaymentType:
        Description: The DB instance attribute field representing the paid type is desirable.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - PaymentType
      PublicConnectionString:
        Description: The public connection string ID of the DB instance.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - PublicConnectionString
      DbInstanceId:
        Description: The ID of the GDB Instance.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - DbInstanceId
      LockReason:
        Description: An instance is locked the reason.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - LockReason
      DbNodeClass:
        Description: The class of the db node.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - DbNodeClass
      MaintainTime:
        Description: Instance maintenance time such as 00:00Z-02:00Z, 0 to 2 points to carry out routine maintenance.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - MaintainTime
      Tags:
        Description: The tags of the GDB Instance.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - Tags
      ZoneId:
        Description: The zone ID of the instance.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - ZoneId
      VSwitchId:
        Description: The vswitch id of the DB instance.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - VSwitchId
      CreateTime:
        Description: Creation time, which follows the format of YYYY-MM-DD 'T'hh:mm:ssZ, such as 2011-05-30 T12:11:4Z.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - CreateTime
      DbNodeCount:
        Description: The count of the db node.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - DbNodeCount
      LatestMinorVersion:
        Description: The latest kernel image version.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - LatestMinorVersion
      Expired:
        Description: The expire status of the db instance.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - Expired
      EcsSecurityGroupRelations:
        Description: Security group information array.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - EcsSecurityGroupRelations
      LockMode:
        Description: Instance lock state.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - LockMode
      DbInstanceMemory:
        Description: Instance memory, which is measured in MB.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - DbInstanceMemory
      ReadOnlyDbInstanceIds:
        Description: The array of the readonly db instances.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - ReadOnlyDbInstanceIds
      VpcId:
        Description: The vpc id of the db instance.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - VpcId
      DBInstanceIPArray:
        Description: IP ADDRESS whitelist for the instance group list.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - DBInstanceIPArray
      DbInstanceDescription:
        Description: According to the practical example or notes.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - DbInstanceDescription
      DbInstanceCpu:
        Description: For example, instances can be grouped according to Cpu core count.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - DbInstanceCpu
      ConnectionString:
        Description: Virtual Private Cloud (vpc connection such as a VPN connection or leased line domain name.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - ConnectionString
      ExpireTime:
        Description: The instance after it expires time for subscription instance.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - ExpireTime
      PublicPort:
        Description: The public port ID of the DB instance.
        Value:
          Fn::GetAtt:
            - ExtensionDataSource
            - PublicPort
    
  • JSON formato

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "DbInstanceId": {
          "Type": "String",
          "Description": {
            "en": "The ID of the GDB Instance."
          },
          "Required": true
        }
      },
      "Resources": {
        "ExtensionDataSource": {
          "Type": "DATASOURCE::GraphDatabase::DbInstance",
          "Properties": {
            "DbInstanceId": {
              "Ref": "DbInstanceId"
            }
          }
        }
      },
      "Outputs": {
        "ResourceGroupId": {
          "Description": "Resource Group ID.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "ResourceGroupId"
            ]
          }
        },
        "DbInstanceNetworkType": {
          "Description": "The network type of the db instance.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "DbInstanceNetworkType"
            ]
          }
        },
        "Port": {
          "Description": "Application Port.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "Port"
            ]
          }
        },
        "DbInstanceType": {
          "Description": "The type of the db instance.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "DbInstanceType"
            ]
          }
        },
        "DbInstanceStorageType": {
          "Description": "Cloud Disk.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "DbInstanceStorageType"
            ]
          }
        },
        "DbNodeStorage": {
          "Description": "Instance storage space, which is measured in GB.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "DbNodeStorage"
            ]
          }
        },
        "DbInstanceCategory": {
          "Description": "The category of the db instance.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "DbInstanceCategory"
            ]
          }
        },
        "DbVersion": {
          "Description": "Kernel Version 1.0 is represented as gremlin,1.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "DbVersion"
            ]
          }
        },
        "CurrentMinorVersion": {
          "Description": "The current kernel image version.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "CurrentMinorVersion"
            ]
          }
        },
        "PaymentType": {
          "Description": "The DB instance attribute field representing the paid type is desirable.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "PaymentType"
            ]
          }
        },
        "PublicConnectionString": {
          "Description": "The public connection string ID of the DB instance.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "PublicConnectionString"
            ]
          }
        },
        "DbInstanceId": {
          "Description": "The ID of the GDB Instance.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "DbInstanceId"
            ]
          }
        },
        "LockReason": {
          "Description": "An instance is locked the reason.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "LockReason"
            ]
          }
        },
        "DbNodeClass": {
          "Description": "The class of the db node.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "DbNodeClass"
            ]
          }
        },
        "MaintainTime": {
          "Description": "Instance maintenance time such as 00:00Z-02:00Z, 0 to 2 points to carry out routine maintenance.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "MaintainTime"
            ]
          }
        },
        "Tags": {
          "Description": "The tags of the GDB Instance.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "Tags"
            ]
          }
        },
        "ZoneId": {
          "Description": "The zone ID of the instance.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "ZoneId"
            ]
          }
        },
        "VSwitchId": {
          "Description": "The vswitch id of the DB instance.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "VSwitchId"
            ]
          }
        },
        "CreateTime": {
          "Description": "Creation time, which follows the format of YYYY-MM-DD 'T'hh:mm:ssZ, such as 2011-05-30 T12:11:4Z.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "CreateTime"
            ]
          }
        },
        "DbNodeCount": {
          "Description": "The count of the db node.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "DbNodeCount"
            ]
          }
        },
        "LatestMinorVersion": {
          "Description": "The latest kernel image version.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "LatestMinorVersion"
            ]
          }
        },
        "Expired": {
          "Description": "The expire status of the db instance.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "Expired"
            ]
          }
        },
        "EcsSecurityGroupRelations": {
          "Description": "Security group information array.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "EcsSecurityGroupRelations"
            ]
          }
        },
        "LockMode": {
          "Description": "Instance lock state.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "LockMode"
            ]
          }
        },
        "DbInstanceMemory": {
          "Description": "Instance memory, which is measured in MB.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "DbInstanceMemory"
            ]
          }
        },
        "ReadOnlyDbInstanceIds": {
          "Description": "The array of the readonly db instances.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "ReadOnlyDbInstanceIds"
            ]
          }
        },
        "VpcId": {
          "Description": "The vpc id of the db instance.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "VpcId"
            ]
          }
        },
        "DBInstanceIPArray": {
          "Description": "IP ADDRESS whitelist for the instance group list.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "DBInstanceIPArray"
            ]
          }
        },
        "DbInstanceDescription": {
          "Description": "According to the practical example or notes.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "DbInstanceDescription"
            ]
          }
        },
        "DbInstanceCpu": {
          "Description": "For example, instances can be grouped according to Cpu core count.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "DbInstanceCpu"
            ]
          }
        },
        "ConnectionString": {
          "Description": "Virtual Private Cloud (vpc connection such as a VPN connection or leased line domain name.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "ConnectionString"
            ]
          }
        },
        "ExpireTime": {
          "Description": "The instance after it expires time for subscription instance.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "ExpireTime"
            ]
          }
        },
        "PublicPort": {
          "Description": "The public port ID of the DB instance.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "PublicPort"
            ]
          }
        }
      }
    }