Use DATASOURCE::SearchEngine::Instances to query OpenSearch Vector Search Edition or Retrieval Engine Edition instances-Resource Orchestration Service(ROS)-阿里云帮助中心

You can use DATASOURCE::SearchEngine::Instances to query instances of OpenSearch Vector Search Edition or Retrieval Engine Edition.

Syntax

{
  "Type": "DATASOURCE::SearchEngine::Instances",
  "Properties": {
    "ResourceGroupId": String,
    "InstanceId": String,
    "RefreshOptions": String
  }
}

Properties

Property Name	Type	Required	Update allowed	Description	Constraint
ResourceGroupId	String	No	Yes	The ID of the resource group.	None
InstanceId	String	No	Yes	The instance ID.	None
RefreshOptions	String	No	Yes	The refresh policy for the data source resource when the stack is updated.	Valid values: Never (default): The data source resource is never refreshed when the stack is updated. Always: The data source resource is always refreshed when the stack is updated.

Response parameters (Fn::GetAtt)

InstanceIds: A list of instance IDs.
Instances: A list of instance details.

Property Name	Type	Description	Constraint
InstanceIds	List	The list of instance IDs.	None
Instances	List	The list of instance details.	None
InstanceId	String	The instance ID.	None
UserName	String	The username.	None
ChargeType	String	The billing method.	Valid value: The Postpay value indicates the pay-as-you-go billing method.
CommodityCode	String	The commodity code.	None
CreateTime	String	The time when the instance was created.	The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC. The format follows the ISO 8601 standard.
UpdateTime	String	The time when the instance was last updated.	The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC. The format follows the ISO 8601 standard.
Description	String	The description of the instance.	None
InDebt	String	Indicates whether the instance is expired.	Valid values: true: The instance is expired. false: The item has not expired.
LockMode	String	The lock mode.	None
Network	String	The network type.	None
ResourceGroupId	String	The ID of the resource group.	None
Spec	String	The instance type.	None
Status	String	The instance status.	None

Examples

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "InstanceId": {
      "Type": "String",
      "Description": "The ID of instance"
    }
  },
  "Resources": {
    "Instances": {
      "Type": "DATASOURCE::SearchEngine::Instances",
      "Properties": {
        "InstanceId": {
          "Ref": "InstanceId"
        }
      }
    }
  },
  "Outputs": {
    "Instances": {
      "Description": "The list of instances.",
      "Value": {
        "Fn::GetAtt": [
          "Instances",
          "Instances"
        ]
      }
    },
    "InstanceIds": {
      "Description": "The list of instance IDs.",
      "Value": {
        "Fn::GetAtt": [
          "Instances",
          "InstanceIds"
        ]
      }
    }
  }
}

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  InstanceId:
    Type: String
    Description: The ID of instance
Resources:
  Instances:
    Type: DATASOURCE::SearchEngine::Instances
    Properties:
      InstanceId:
        Ref: InstanceId
Outputs:
  Instances:
    Description: The list of instances.
    Value:
      Fn::GetAtt:
        - Instances
        - Instances
  InstanceIds:
    Description: The list of instance IDs.
    Value:
      Fn::GetAtt:
        - Instances
        - InstanceIds