You need to enable JavaScript to run this app.
文档中心
AgentKit

AgentKit

复制全文
下载 pdf
SessionStore
ListSessionStores - 批量查询会话资源详情
复制全文
下载 pdf
ListSessionStores - 批量查询会话资源详情
通过自定义筛选条件批量查询会话资源详情。​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:ListSessionStores​
要执行的操作,取值:ListSessionStores。​
​
Version string 必选 示例值:2025-10-30​
API的版本,取值:2025-10-30。​
​
CreateTimeAfter string 可选 示例值:2026-02-11T20:00:47+8:00​
筛选该时间点后创建的会话资源。(RFC3339格式)​
​
CreateTimeBefore string 可选 示例值:2026-02-11T10:05:37+8:00​
筛选该时间点前创建的会话资源。(RFC3339格式)​
​
Filters.N.Name string[] 可选 示例值:status​
精确过滤的字段名。​
  • 参数 - N:表示过滤条件的序号,取值范围:1~10。​
  • 多个字段名之间用&分隔,为“或”的关系。​
  • 取值:​
  • session_store_id:会话资源ID。​
  • name:会话资源名称。​
  • status:会话资源状态。​
  • provider_type:导入的会话资源平台类型。​
说明​
当Filters.N.Name和Filters.N.NameContains同时传入时,仅Filters.N.Name生效。​
​
Filters.N.NameContains string[] 可选 示例值:sample description​
模糊过滤的字段名。​
  • 参数 - N:表示过滤条件的序号,取值范围:1~10。​
  • 多个字段名之间用&分隔,为“或”的关系。​
  • 取值:​
  • name:会话资源名称。​
  • description:会话资源描述。​
  • provider_type:导入的会话资源平台类型。​
说明​
当Filters.N.Name和Filters.N.NameContains同时传入时,仅Filters.N.Name生效。​
​
Filters.N.Values.N string[] 可选 示例值:Ready​
过滤字段的值。​
  • 参数 - N:表示过滤条件的序号,取值范围:1~10。​
  • 多个字段名之间用&分隔。​
当过滤条件为status时,取值:​
  • Creating:创建中。​
  • CreateFailed:创建失败。​
  • Ready:可用。​
  • Deleting:删除中。​
  • DeleteFailed:删除失败。​
  • Deleted:资源失效。​
  • Error:错误。​
当过滤条件为provider_type时,取值:​
  • RDS_MYSQL:云数据库MySQL。​
  • RDS_PG:云数据库PostgreSQL。​
​
MaxResults integer 可选 示例值:10​
分页查询时设置的每页行数。​
  • 最小值:1。​
  • 最大值:100。​
  • 默认值:10。​
​
NextToken string 可选 示例值:bS15ZTcwMjZiaWY0cTdvaTVjc3****==​
分页查询凭证,用于标记分页的位置,初次调用该接口时无需设置。下次查询时,取值为上一次API调用返回的NextToken参数值。​
​
PageNumber integer 可选 示例值:1​
当前页码。​
  • 起始值:1。​
  • 默认值:1。​
​
PageSize integer 可选 示例值:10​
分页查询时设置的每页行数。​
  • 取值范围:1~100。​
  • 默认值:10。​
​
ProjectName string 可选 示例值:default​
所属项目名称。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
PageNumber integer 示例值:1​
当前页码。​
  • 起始值:1。​
  • 默认值:1。​
​
PageSize integer 示例值:10​
分页查询时设置的每页行数。​
  • 取值范围:1~100。​
  • 默认值:10。​
​
SessionStores object[] 示例值:--​
会话资源信息。​
AssociatedAgentsCount integer 示例值:1​
关联的Agent数量。​
​
CreateTime string 示例值:2026-02-10T10:00:00+8:00​
会话资源创建时间。(RFC3339)​
​
DatabaseConfiguration object 示例值:--​
数据库配置信息。​
AccountName string 示例值:user_admin​
数据库账号名称。​
​
Database string 示例值:mydb​
数据库名称。​
​
EndpointConfiguration object 示例值:--​
数据库连接点配置信息。​
EndpointId string 示例值:mysql-6284d149****-cluster​
连接点ID。​
  • RDS_MYSQL:EndpointId。​
  • RDS_PG:EndpointId。​
​
PrivateEndpoint string 示例值:mysql33f0bf03*****.rds.ivolces.com:3306​
私网连接地址。​
​
PublicEndpoint string 示例值:mysql-33f0bf03****-public.rds.volces.com:3306​
公网连接地址。​
​
​
InstanceId string 示例值:mysql-33f0bf03****​
数据库实例ID。​
  • RDS_MYSQL:InstanceId,例如“mysql-33f0bf03****”。​
  • RDS_PG:InstanceId,例如“postgres-8a4cf530****”。​
​
​
Description string 示例值:my session store​
会话资源描述。​
​
Managed boolean 示例值:true​
是否由平台管理。​
​
Name string 示例值:my_session_store​
会话资源名称。​
​
ProjectName string 示例值:default​
所属项目名称。​
​
ProviderType string 示例值:RDS_MYSQL​
底层存储类型。包括:​
  • RDS_MYSQL:云数据库MySQL。​
  • RDS_PG:云数据库PostgreSQL。​
​
SessionStoreId string 示例值:ss-****​
会话资源ID。​
​
Status string 示例值:Ready​
会话库状态,包括:​
  • Creating:创建中。​
  • CreateFailed:创建失败。​
  • Ready:可用。​
  • Deleting:删除中。​
  • DeleteFailed:删除失败。​
  • Deleted:资源失效。​
  • Error:错误。​
​
UpdateTime string 示例值:2026-02-11T18:00:00+8:00​
会话资源更新时间。(RFC3339)​
​
VpcId string 示例值:vpc-****​
私有网络ID。​
​
​
TotalCount integer 示例值:1​
符合条件的会话资源总个数。​
​
​
​
请求示例​
​
POST https://agentkit.cn-beijing.volcengineapi.com?Action=ListSessionStores&Version=2025-10-30 HTTP/1.1​
Content-Type: application/json; charset=UTF-8​
{​
"PageSize": 10,​
"PageNumber": 1,​
"CreateTimeAfter": "2025-09-01T00:00:00Z",​
"Filters": [​
{​
"Name": "name",​
"NameContains": "agent"​
},​
{​
"Name": "status",​
"Values": [​
"Ready"​
]​
},​
{​
"Name": "provider_type",​
"Values": [​
"RDS_MYSQL"​
]​
}​
]​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20251125162502098132110105524B2F",​
"Action": "ListSessionStores",​
"Version": "2025-10-30",​
"Service": "agentkit",​
"Region": "cn-beijing"​
},​
"Result": {​
"MaxResults": 20,​
"NextToken": "eyJwYWdlIjoyLCJzaXplIjoxMH0",​
"Filters": [​
{​
"Name": "status",​
"Values": [​
"Ready",​
"Deleted"​
]​
}​
]​
}​
}​
​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidProjectName.Malformed​
The specified ProjectName is malformed.​
指定的ProjectName不合法。​
​
​
最近更新时间:2026.03.16 15:20:02
这个页面对您有帮助吗?
有用
有用
无用
无用