Skip to main content
Back to top
Ctrl
+
K
Getting Started
Use Cases
Documentation
Blog
English
中文
Choose version
English
中文
Choose version
Search
Ctrl
+
K
Home
Getting Started
Installation and Deployment
Installation Guide
Deploy openYuanrong Cluster on Hosts
Getting Started
User Guide
Environment Preparation
Deploy openYuanrong
Secure Communication
Deployment Parameters Table
Deploy openYuanrong Cluster on K8s
User Guide
Environment Preparation
Deploy openYuanrong
Specifications and Restrictions
Resource Pool Management API
Create Pod Resource Pool
Update Pod Resource Pool
Query Pod Resource Pool
Delete Pod Resource Pool
Deploy openYuanrong Job Applications
Job Management API
Submit Job
Query Job Details
Query Job List
Delete Job
Stop Job
Deploy openYuanrong Service Applications
Use Cases
Deploy Multi-Machine PD Separation Service Based on vLLM, Long Sequence Inference TTFT Reduced by 20%
Inference Instance Model Loading Speed 10x Improvement, Fast Elastic Response to Business Traffic Changes
Migrate SpringBoot Container Microservices to openYuanrong
Multi-Language Function Programming Interface
Key Concepts
Development Guide
Stateful Functions
Named Instances
Concurrency
Fault Tolerance
Stateless Functions
Concurrency
Fault Tolerance
Data Objects
KV Cache
Data Streams
Function Services
Configuring Functions
Version Management
Scheduling
Resources
Affinity
Advanced Tutorials
Custom Graceful Shutdown
openYuanrong Generators
Zero Serialization/Deserialization for APIs
Avoid Excessive Concurrency
Nested Calls
Using yr.wait to Limit Concurrent/Pending Tasks
Using Resource Limits to Control Task Concurrency
Building Tree-Shaped Job Graphs with Stateful Functions
AI Agent Sessions and Affinity Scheduling
Using Stateful Functions as Global Signal Stations
Examples
Simple Function Programming Examples
Using Data Streams in Functions
Multi-turn Dialogue Assistant Based on AI Agent Session
Running Distributed Jobs in Function Service
Configure Function Instance Affinity
Using NPU Resources in Stateful Functions
Function Service Connecting to Backend Storage
Implementing MapReduce Based on openYuanrong
Implementing Monte Carlo Method Based on openYuanrong
Implementing Reinforcement Learning Maze Based on openYuanrong
Cross-Language Invocation of Stateless and Stateful Functions
API
Distributed Parallelization SDK for Single-Machine Programs
Python
yr.init
yr.is_initialized
yr.finalize
yr.Config
yr.Config.auth_token
yr.Config.auto
yr.Config.certificate_file_path
yr.Config.code_dir
yr.Config.connection_nums
yr.Config.cpp_auto_function_name
yr.Config.cpp_function_id
yr.Config.dedup_logs
yr.Config.deployment_config
yr.Config.ds_address
yr.Config.ds_public_key_path
yr.Config.enable_ds_encrypt
yr.Config.enable_metrics
yr.Config.enable_mtls
yr.Config.enable_tls
yr.Config.env_file
yr.Config.function_id
yr.Config.function_name
yr.Config.http_ioc_threads_num
yr.Config.in_cluster
yr.Config.invoke_timeout
yr.Config.is_driver
yr.Config.job_id
yr.Config.local_mode
yr.Config.log_dir
yr.Config.log_file_num_max
yr.Config.log_file_size_max
yr.Config.log_flush_interval
yr.Config.log_level
yr.Config.log_to_driver
yr.Config.max_task_instance_num
yr.Config.ns
yr.Config.num_cpus
yr.Config.private_key_paaswd
yr.Config.private_key_path
yr.Config.recycle_time
yr.Config.rpc_timeout
yr.Config.rt_server_address
yr.Config.runtime_env
yr.Config.runtime_id
yr.Config.runtime_private_key_path
yr.Config.runtime_public_key_path
yr.Config.server_address
yr.Config.server_name
yr.Config.tenant_id
yr.Config.tls_config
yr.Config.verify_file_path
yr.Config.working_dir
yr.Config.load_paths
yr.Config.custom_envs
yr.Config.master_addr_list
yr.Config.__init__
yr.config.ClientInfo
yr.config.ClientInfo.job_id
yr.config.ClientInfo.__init__
yr.invoke
yr.FunctionProxy
yr.FunctionProxy.__init__
yr.FunctionProxy.create_opts_wrapper
yr.FunctionProxy.get_original_func
yr.FunctionProxy.invoke
yr.FunctionProxy.invoke_function_for_testing
yr.FunctionProxy.options
yr.FunctionProxy.set_function_group_size
yr.FunctionProxy.set_urn
yr.instance
yr.InstanceProxy
yr.InstanceProxy.real_id
yr.InstanceProxy.__init__
yr.InstanceProxy.deserialization_
yr.InstanceProxy.get_function_group_handler
yr.InstanceProxy.is_activate
yr.InstanceProxy.serialization_
yr.InstanceProxy.snapshot
yr.InstanceProxy.snapstart
yr.InstanceProxy.terminate
yr.method
yr.MethodProxy
yr.MethodProxy.__init__
yr.MethodProxy.invoke
yr.MethodProxy.options
yr.get_instance
yr.InstanceCreator
yr.InstanceCreator.user_class_descriptor
yr.InstanceCreator.__init__
yr.InstanceCreator.create_cpp_user_class
yr.InstanceCreator.create_cross_user_class
yr.InstanceCreator.create_from_user_class
yr.InstanceCreator.create_instance_for_testing
yr.InstanceCreator.get_instance
yr.InstanceCreator.get_original_cls
yr.InstanceCreator.invoke
yr.InstanceCreator.options
yr.InstanceCreator.set_function_group_size
yr.InstanceCreator.snapstart
yr.cancel
yr.exit
yr.save_state
yr.load_state
yr.InvokeOptions
yr.InvokeOptions.concurrency
yr.InvokeOptions.cpu
yr.InvokeOptions.get_if_exists
yr.InvokeOptions.group_name
yr.InvokeOptions.instance_priority
yr.InvokeOptions.is_data_affinity
yr.InvokeOptions.is_delete_remote_tensor
yr.InvokeOptions.max_instances
yr.InvokeOptions.max_invoke_latency
yr.InvokeOptions.memory
yr.InvokeOptions.min_instances
yr.InvokeOptions.name
yr.InvokeOptions.namespace
yr.InvokeOptions.need_order
yr.InvokeOptions.preempted_allowed
yr.InvokeOptions.preferred_anti_other_labels
yr.InvokeOptions.preferred_priority
yr.InvokeOptions.recover_retry_times
yr.InvokeOptions.required_priority
yr.InvokeOptions.retry_times
yr.InvokeOptions.schedule_timeout_ms
yr.InvokeOptions.skip_serialize
yr.InvokeOptions.trace_id
yr.InvokeOptions.custom_resources
yr.InvokeOptions.custom_extensions
yr.InvokeOptions.pod_labels
yr.InvokeOptions.labels
yr.InvokeOptions.affinity
yr.InvokeOptions.device
yr.InvokeOptions.schedule_affinities
yr.InvokeOptions.resource_group_options
yr.InvokeOptions.function_group_options
yr.InvokeOptions.env_vars
yr.InvokeOptions.alias_params
yr.InvokeOptions.runtime_env
yr.InvokeOptions.debug
yr.InvokeOptions.port_forwardings
yr.InvokeOptions.__init__
yr.InvokeOptions.check_options_range
yr.InvokeOptions.check_options_valid
yr.list_named_instances
yr.put
yr.get
yr.wait
yr.object_ref.ObjectRef
yr.object_ref.ObjectRef.id
yr.object_ref.ObjectRef.task_id
yr.object_ref.ObjectRef.__init__
yr.object_ref.ObjectRef.as_future
yr.object_ref.ObjectRef.cancel
yr.object_ref.ObjectRef.done
yr.object_ref.ObjectRef.exception
yr.object_ref.ObjectRef.get
yr.object_ref.ObjectRef.get_future
yr.object_ref.ObjectRef.is_exception
yr.object_ref.ObjectRef.on_complete
yr.object_ref.ObjectRef.set_data
yr.object_ref.ObjectRef.set_exception
yr.object_ref.ObjectRef.wait
yr.ProducerConfig
yr.ProducerConfig.auto_clean_up
yr.ProducerConfig.delay_flush_time
yr.ProducerConfig.encrypt_stream
yr.ProducerConfig.max_stream_size
yr.ProducerConfig.page_size
yr.ProducerConfig.reserve_size
yr.ProducerConfig.retain_for_num_consumers
yr.ProducerConfig.extend_config
yr.ProducerConfig.__init__
yr.SubscriptionConfig
yr.SubscriptionConfig.subscriptionType
yr.SubscriptionConfig.subscription_name
yr.SubscriptionConfig.extend_config
yr.SubscriptionConfig.__init__
yr.Element
yr.Element.__init__
yr.create_stream_producer
yr.create_stream_consumer
yr.delete_stream
yr.fnruntime.Producer
yr.fnruntime.Producer.__init__
yr.fnruntime.Producer.close
yr.fnruntime.Producer.send
yr.fnruntime.Consumer
yr.fnruntime.Consumer.__init__
yr.fnruntime.Consumer.ack
yr.fnruntime.Consumer.close
yr.fnruntime.Consumer.receive
yr.cpp_function
yr.cpp_instance_class
yr.cpp_instance_class.__init__
yr.cpp_instance_class.get_class_name
yr.cpp_instance_class.get_factory_name
yr.cpp_instance_class.get_function_key
yr.cpp_instance_class.invoke
yr.cpp_instance_class.options
yr.java_function
yr.java_instance_class
yr.create_function_group
yr.get_function_group_context
yr.FunctionGroupOptions
yr.FunctionGroupOptions.concurrency
yr.FunctionGroupOptions.cpu
yr.FunctionGroupOptions.memory
yr.FunctionGroupOptions.recover_retry_times
yr.FunctionGroupOptions.scheduling_affinity_each_bundle_size
yr.FunctionGroupOptions.scheduling_affinity_type
yr.FunctionGroupOptions.timeout
yr.FunctionGroupOptions.resources
yr.FunctionGroupOptions.__init__
yr.FunctionGroupContext
yr.FunctionGroupContext.device_name
yr.FunctionGroupContext.rank_id
yr.FunctionGroupContext.world_size
yr.FunctionGroupContext.server_list
yr.FunctionGroupContext.__init__
yr.FunctionGroupHandler
yr.FunctionGroupHandler.__init__
yr.FunctionGroupHandler.accelerate
yr.FunctionGroupHandler.terminate
yr.FunctionGroupMethodProxy
yr.FunctionGroupMethodProxy.use_shared_memory
yr.FunctionGroupMethodProxy.rpc_broadcast_mq
yr.FunctionGroupMethodProxy.__init__
yr.FunctionGroupMethodProxy.invoke
yr.FunctionGroupMethodProxy.set_rpc_broadcast_mq
yr.device.DataInfo
yr.device.DataInfo.__init__
yr.create_resource_group
yr.remove_resource_group
yr.ResourceGroup
yr.ResourceGroup.bundle_count
yr.ResourceGroup.bundle_specs
yr.ResourceGroup.resource_group_name
yr.ResourceGroup.__init__
yr.ResourceGroup.wait
yr.config.ResourceGroupOptions
yr.config.ResourceGroupOptions.bundle_index
yr.config.ResourceGroupOptions.resource_group_name
yr.config.ResourceGroupOptions.__init__
yr.config.SchedulingAffinityType
yr.config.SchedulingAffinityType.real
yr.config.SchedulingAffinityType.imag
yr.config.SchedulingAffinityType.numerator
yr.config.SchedulingAffinityType.denominator
yr.config.SchedulingAffinityType.REQUIRED_AFFINITY_IN_EACH_BUNDLE
yr.config.SchedulingAffinityType.conjugate
yr.config.SchedulingAffinityType.bit_length
yr.config.SchedulingAffinityType.to_bytes
yr.config.SchedulingAffinityType.from_bytes
yr.config.SchedulingAffinityType.as_integer_ratio
yr.config.UserTLSConfig
yr.config.UserTLSConfig.server_name
yr.config.UserTLSConfig.root_cert_path
yr.config.UserTLSConfig.module_cert_path
yr.config.UserTLSConfig.module_key_path
yr.config.UserTLSConfig.__init__
yr.config.DeploymentConfig
yr.config.DeploymentConfig.cpu
yr.config.DeploymentConfig.datamem
yr.config.DeploymentConfig.mem
yr.config.DeploymentConfig.spill_limit
yr.config.DeploymentConfig.spill_path
yr.config.DeploymentConfig.__init__
yr.Group
yr.Group.group_name
yr.Group.group_opts
yr.Group.__init__
yr.Group.invoke
yr.Group.resume
yr.Group.suspend
yr.Group.terminate
yr.Group.wait
yr.config.GroupOptions
yr.config.GroupOptions.same_lifecycle
yr.config.GroupOptions.strategy
yr.config.GroupOptions.timeout
yr.config.GroupOptions.__init__
yr.kv_write
yr.kv_write_with_param
yr.kv_m_write_tx
yr.kv_read
yr.kv_del
yr.kv_set
yr.kv_get
yr.kv_get_with_param
yr.ExistenceOpt
yr.ExistenceOpt.NONE
yr.ExistenceOpt.NX
yr.WriteMode
yr.WriteMode.NONE_L2_CACHE
yr.WriteMode.WRITE_THROUGH_L2_CACHE
yr.WriteMode.WRITE_BACK_L2_CACHE
yr.WriteMode.NONE_L2_CACHE_EVICT
yr.CacheType
yr.CacheType.MEMORY
yr.CacheType.DISK
yr.ConsistencyType
yr.ConsistencyType.PRAM
yr.ConsistencyType.CAUSAL
yr.GetParam
yr.GetParam.offset
yr.GetParam.size
yr.GetParam.__init__
yr.GetParams
yr.GetParams.get_params
yr.GetParams.__init__
yr.SetParam
yr.SetParam.cache_type
yr.SetParam.existence
yr.SetParam.ttl_second
yr.SetParam.write_mode
yr.SetParam.__init__
yr.MSetParam
yr.MSetParam.cache_type
yr.MSetParam.existence
yr.MSetParam.ttl_second
yr.MSetParam.write_mode
yr.MSetParam.__init__
yr.CreateParam
yr.CreateParam.cache_type
yr.CreateParam.consistency_type
yr.CreateParam.__init__
yr.Gauge
yr.Gauge.__init__
yr.Gauge.add_labels
yr.Gauge.set
yr.Alarm
yr.Alarm.__init__
yr.Alarm.set
yr.AlarmInfo
yr.AlarmInfo.alarm_name
yr.AlarmInfo.alarm_severity
yr.AlarmInfo.cause
yr.AlarmInfo.ends_at
yr.AlarmInfo.location_info
yr.AlarmInfo.starts_at
yr.AlarmInfo.timeout
yr.AlarmInfo.custom_options
yr.AlarmInfo.__init__
yr.AlarmSeverity
yr.AlarmSeverity.OFF
yr.AlarmSeverity.INFO
yr.AlarmSeverity.MINOR
yr.AlarmSeverity.MAJOR
yr.AlarmSeverity.CRITICAL
yr.DoubleCounter
yr.DoubleCounter.__init__
yr.DoubleCounter.add_labels
yr.DoubleCounter.get_value
yr.DoubleCounter.increase
yr.DoubleCounter.reset
yr.DoubleCounter.set
yr.UInt64Counter
yr.UInt64Counter.__init__
yr.UInt64Counter.add_labels
yr.UInt64Counter.get_value
yr.UInt64Counter.increase
yr.UInt64Counter.reset
yr.UInt64Counter.set
yr.resources
yr.affinity.AffinityType
yr.affinity.AffinityType.PREFERRED
yr.affinity.AffinityType.PREFERRED_ANTI
yr.affinity.AffinityType.REQUIRED
yr.affinity.AffinityType.REQUIRED_ANTI
yr.affinity.AffinityKind
yr.affinity.AffinityKind.RESOURCE
yr.affinity.AffinityKind.INSTANCE
yr.affinity.OperatorType
yr.affinity.OperatorType.LABEL_IN
yr.affinity.OperatorType.LABEL_NOT_IN
yr.affinity.OperatorType.LABEL_EXISTS
yr.affinity.OperatorType.LABEL_NOT_EXISTS
yr.affinity.LabelOperator
yr.affinity.LabelOperator.__init__
yr.affinity.Affinity
yr.affinity.Affinity.affinity_scope
yr.affinity.Affinity.affinity_kind
yr.affinity.Affinity.affinity_type
yr.affinity.Affinity.label_operators
yr.affinity.Affinity.__init__
yr.exception.YRError
yr.exception.CancelError
yr.exception.YRInvokeError
yr.exception.YRequestError
C++
Init
IsInitialized
IsLocalMode
Finalize
Struct Config
struct InstanceRange
Exception
YR_INVOKE
YR_STATE
YR_RECOVER
YR_SHUTDOWN
Function
FunctionHandler::Invoke
FunctionHandler::Options
FunctionHandler::SetUrn
Instance
InstanceCreator::Invoke
InstanceCreator::Options
InstanceCreator::SetUrn
InstanceFunctionHandler::Invoke
InstanceFunctionHandler::Options
NamedInstance
GetInstance
Cancel
Exit
SaveState
LoadState
struct InvokeOptions
RuntimeEnv
Put
Get
Wait
ObjectRef
Stream
Collective
PyFunction
PyInstanceClass::FactoryCreate
JavaFunction
JavaInstanceClass FactoryCreate
CppFunction
CppInstanceClass FactoryCreate
Group
KV().Set
KV().MSetTx
KV().Write
KV().MWriteTx
KV().WriteRaw
KV().Get
KV().GetWithParam
KV().Read
KV().ReadRaw
KV().Del
ParallelFor
Affinity
Java
init
Finalize
Config
invoke
function
FunctionHandler
function options
Instance
InstanceCreator
InstanceHandler
InstanceHandler function
InstanceFunctionHandler
InstanceHandler exportHandler
InstanceHandler importHandler
InstanceHandler terminate
saveState
loadState
yrShutdown
yrRecover
InvokeOptions
put
get
wait
ObjectRef
Stream
setUrn
CppFunction
CppFunctionHandler
CppInstanceClass
CppInstanceMethod
CppInstanceCreator
CppInstanceHandler
CppInstanceHandler function
CppInstanceFunctionHandler
CppInstanceHandler exportHandler
CppInstanceHandler importHandler
CppInstanceHandler terminate
JavaFunction
JavaFunctionHandler
JavaInstanceClass
JavaInstanceMethod
JavaInstanceCreator
JavaInstanceHandler
JavaInstanceHandler function
JavaInstanceFunctionHandler
JavaInstanceHandler exportHandler
JavaInstanceHandler importHandler
JavaInstanceHandler terminate
VoidFunctionHandler
VoidInstanceFunctionHandler
YR.kv().set()
YR.kv().mSetTx()
YR.kv().Write()
YR.kv().mWriteTx()
YR.kv().get()
YR.kv().getWithParam()
YR.kv().read()
YR.kv().del
Group
Affinity
Function Service API
Python SDK
yr.Context
yr.Context.__init__
yr.Context.getAccessKey
yr.Context.getAlias
yr.Context.getAuthToken
yr.Context.getCPUNumber
yr.Context.getFunctionName
yr.Context.getLogger
yr.Context.getMemorySize
yr.Context.getPackage
yr.Context.getProjectID
yr.Context.getRemainingTimeInMilliSeconds
yr.Context.getRequestID
yr.Context.getRunningTimeInSeconds
yr.Context.getSecretKey
yr.Context.getSecurityAccessKey
yr.Context.getSecuritySecretKey
yr.Context.getSecurityToken
yr.Context.getTenantID
yr.Context.getUserData
yr.Context.getVersion
yr.Context.get_instance_id
yr.Context.get_invoke_id
yr.Context.get_invoke_property
yr.Context.get_session_id
yr.Context.get_session_service
yr.Context.get_state
yr.Context.get_stream
yr.Context.get_trace_id
yr.Context.setAccessKey
yr.Context.setAuthToken
yr.Context.setSecretKey
yr.Context.setSecurityAccessKey
yr.Context.setSecuritySecretKey
yr.Context.setSecurityToken
yr.Context.set_instance_id
yr.Context.set_session_id
yr.Context.set_state
yr.Context.set_trace_id
yr.SessionService
yr.SessionService.__init__
yr.SessionService.load_session
yr.ManagedSessionObj
yr.ManagedSessionObj.__init__
yr.ManagedSessionObj.get_histories
yr.ManagedSessionObj.get_id
yr.ManagedSessionObj.is_interrupted
yr.ManagedSessionObj.notify
yr.ManagedSessionObj.set_histories
yr.ManagedSessionObj.wait_for_notify
yr.Function
yr.Function.__init__
yr.Function.invoke
yr.Function.options
C++ SDK
Java SDK
Invoke Service
Subscribe to Stream Service
Interrupt Session
Delete Session
Register Function
Update Function
Publish Function
Query Specific Version of Function
Query All Versions of Function
Query Function List
Delete Function
Create Reserved Instance Configuration
Update Reserved Instance Configuration
Query Reserved Instance Configuration
Delete Reserved Instance Configuration
CLI - the yr command
start
launch
health
status
stop
config
–version
Error Codes
More Usage
Use Data System Alone
Monitoring and Debugging
Dashboard
Logs
Metrics
System Metrics
Alarm Metrics
Configure and Obtain Metrics
Application Metrics
Tracing
Distributed Fusion Call Stack
FAQ
Multi-language Function Programming FAQ
Installation and Deployment FAQ
Contributor Guide
Compile openYuanrong from Source Code
Contribution Documentation
Reference
Development Tools
Blog
Download openYuanrong
Glossary
Security
yr.Context.get_instance_id
Contents
Context.get_instance_id()
yr.Context.get_instance_id
#
Context.
get_instance_id
(
)
[source]
#
Method get_instance_id, not exposed
Contents
Context.get_instance_id()
