# 查询关系实体的数据实例 - ListQueryRelationship #### 功能介绍 本接口用于分页查询关系实体的数据实例。通过指定数据实例ID及对应的关系角色（源/目标），或数据模型的英文名称及对应的关系角色（源类型/目标类型），返回匹配的关系实体数据实例信息。 如果对应的关系实体存在"参考对象"类型属性，且参考的数据模型为抽象模型，返回信息仅返回对应模型的英文名称和ID。如果参考的数据模型为实体模型，返回空。 #### 接口约束 目标数据模型必须是关系实体。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/iDMEClassicAPI/doc?api=ListQueryRelationship)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-idme/idme_api_0017.html)。 #### URI POST /rdm_{identifier}_app/publicservices/api/{modelName}/queryRelationship/{pageSizePath}/{curPagePath} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | identifier | 是 | String | **参数解释：** 应用的唯一标识。 - 于2023年06月01日之前创建的应用，其唯一标识为该应用的名称。 - 于2023年06月01日之后创建的应用，其唯一标识为该应用的ID。 获取方法请参见[获取运行服务清单 - ListEnvs](https://support.huaweicloud.com/api-idme/ListApps.html)。 **约束限制：** 不涉及。 **取值范围：** - 于2023年06月01日之前创建的应用：由英文字母和数字组成，长度为1-36个字符。 - 于2023年06月01日之后创建的应用：由英文字母和数字组成，且长度为32个字符。 **默认取值：** 不涉及。 | | modelName | 是 | String | **参数解释：** 数据模型的英文名称。 **约束限制：** 不涉及。 **取值范围：** 以大写字母开头，只能包含字母、数字、"_"，且长度为1-60个字符。 **默认取值：** 不涉及。 | | pageSizePath | 是 | Integer | **参数解释：** 分页大小，即每页返回的实例数量。 **约束限制：** 不涉及。 **取值范围：** 1-1000。 **默认取值：** 不涉及。 | | curPagePath | 是 | Integer | **参数解释：** 当前页数，从1开始计数。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 1。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | curPage | 否 | Integer | **参数解释：** 当前页码，从1开始计数。当路径参数curPagePath未指定时生效。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 1。 | | endIndex | 否 | Integer | **参数解释：** 结束索引，用于指定查询结果的结束位置。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 0。 | | maxPageSize | 否 | Integer | **参数解释：** 最大分页数，用于限制返回的最大页数。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 1000。 | | pageSize | 否 | Integer | **参数解释：** 分页大小，即每页返回的实例数量。当路径参数pageSizePath未指定时生效。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 1000。 | | startIndex | 否 | Integer | **参数解释：** 起始索引，用于指定查询结果的起始位置。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 0。 | | totalPages | 否 | Integer | **参数解释：** 总页数，用于指定查询的总页数。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 0。 | | totalRows | 否 | Integer | **参数解释：** 总行数，用于指定查询的总行数。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 0。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** IAM用户的token。 获取方法请参见[获取IAM用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | applicationId | 否 | String | **参数解释：** 应用ID，用于指定实例所属的应用。 当URL路径中已能明确应用上下文时，此参数可不传。 获取方法请参见[获取租户下的应用清单 - ListApps](https://support.huaweicloud.com/api-idme/ListApps.html)。 **约束限制：** 不涉及。 **取值范围：** - 于2023年06月01日之前创建的应用：由英文字母和数字组成，长度为1-36个字符。 - 于2023年06月01日之后创建的应用：由英文字母和数字组成，且长度为32个字符。 **默认取值：** 不涉及。 | | params | 是 | [GenericLinkQueryDTO] object | **参数解释：** 请求参数对象，包含查询角色、对象标识及过滤条件等。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表5GenericLinkQueryDTO | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | role | 否 | String | **参数解释：** 查询角色，用于指定按哪种角色维度查询关系实例。 **约束限制：** 必须与objectId配合使用。 **取值范围：** - TARGET：目标模型。 - SOURCE：源模型。 - TARGET_TYPE：目标模型对应的英文名称。 - SOURCE_TYPE：源模型对应的英文名称。 **默认取值：** 不涉及。 | | objectId | 否 | String | **参数解释：** 查询对象标识，与role参数配合使用。 **约束限制：** - 当role为SOURCE或TARGET时，值为角色对应数据实例ID。 - 当role为SOURCE_TYPE或TARGET_TYPE时，值为角色对应的数据模型的英文名称。 **取值范围：** - 当role为SOURCE或TARGET时，取值范围为：-9223372036854775808到9223372036854775807的整数。 - 当role为SOURCE_TYPE或TARGET_TYPE时，以大写字母开头，只能包含字母、数字、"_"，且长度为1-60个字符。 **默认取值：** 不涉及。 | | latestOnly | 否 | Boolean | **参数解释：** 是否仅返回关联的最新版本目标模型数据实例。此参数仅当源模型或目标模型为M-V模型实体时生效。 **约束限制：** 仅对M-V模型实体有效。 **取值范围：** - true：仅返回关联的最新版本目标模型数据实例。 - false：返回关联的所有版本目标模型数据实例。 **默认取值：** false。 | | isNeedTotal | 否 | Boolean | **参数解释：** 是否需要查询总记录数。开启后响应中的pageInfo将包含准确的totalRows和totalPages，但可能影响查询性能。 **约束限制：** 不涉及。 **取值范围：** - true：需要。 - false：不需要。 **默认取值：** false。 | #### 响应参数 **状态码：200** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | String | **参数解释：** 请求处理结果状态。 **取值范围：** - SUCCESS：请求成功。 - FAIL：请求失败。 | | data | Array of [RelationModelViewDTO] objects | **参数解释：** 请求数据。 **取值范围：** 不涉及。 | | errors | Array of strings | **参数解释：** 异常信息列表。当result为FAIL时，返回具体的错误描述，包含失败原因及建议处理方式。 **取值范围：** 不涉及。 | | pageInfo | [PageInfoViewDTO] object | **参数解释：** 分页信息。 **取值范围：** 不涉及。 | 表7RelationModelViewDTO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | className | String | **参数解释：** 类名。 **取值范围：** 不涉及。 | | createTime | String | **参数解释：** 创建时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 **取值范围：** 不涉及。 | | creator | String | **参数解释：** 创建者账号。 **取值范围：** 不涉及。 | | description | String | **参数解释：** 实体描述。 **取值范围：** 不涉及。 | | id | String | **参数解释：** 唯一标识。 **取值范围：** -9223372036854775808到9223372036854775807的整数。 | | lastUpdateTime | String | **参数解释：** 最后更新时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 **取值范围：** 不涉及。 | | modifier | String | **参数解释：** 更新者账号。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 名称。 **取值范围：** 不涉及。 | | rdmDeleteFlag | Integer | **参数解释：** 软删除标识。 **取值范围：** - 0：表示未删除。 - 1：表示已删除。 | | rdmExtensionType | String | **参数解释：** 扩展类型。 **取值范围：** 不涉及。 | | rdmVersion | Integer | **参数解释：** 系统版本。 **取值范围：** 不涉及。 | | source | [ClassesViewDTO] object | **参数解释：** 源实体。 **取值范围：** 不涉及。 | | target | [StudentViewDTO] object | **参数解释：** 目标实体。 **取值范围：** 不涉及。 | | tenant | [TenantViewDTO] object | **参数解释：** 租户信息。 **取值范围：** 不涉及。 | 表8ClassesViewDTO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | className | String | **参数解释：** 类名。 **取值范围：** 不涉及。 | | createTime | String | **参数解释：** 创建时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 **取值范围：** 不涉及。 | | creator | String | **参数解释：** 创建者账号。 **取值范围：** 不涉及。 | | description | String | **参数解释：** 描述。 **取值范围：** 不涉及。 | | id | String | **参数解释：** 唯一标识。 **取值范围：** -9223372036854775808到9223372036854775807的整数。 | | kiaguid | String | **参数解释：** 关键信息资产ID。 **取值范围：** 不涉及。 | | lastUpdateTime | String | **参数解释：** 最新更新时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 **取值范围：** 不涉及。 | | modifier | String | **参数解释：** 更新者账号。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 名称。 **取值范围：** 不涉及。 | | rdmDeleteFlag | Integer | **参数解释：** 软删除标识。 **取值范围：** - 0：表示未删除。 - 1：表示已删除。 | | rdmExtensionType | String | **参数解释：** 扩展类型。 **取值范围：** 不涉及。 | | rdmVersion | Integer | **参数解释：** 系统版本。 **取值范围：** 不涉及。 | | securityLevel | String | **参数解释：** 安全密级。 **取值范围：** - internal：内部公开。 - secret：秘密。 - confidential：机密。 - top_secret：绝密。 | | tenant | [TenantViewDTO] object | **参数解释：** 租户信息。 **取值范围：** 不涉及。 | 表9StudentViewDTO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | className | String | **参数解释：** 类名。 **取值范围：** 不涉及。 | | createTime | String | **参数解释：** 创建时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 **取值范围：** 不涉及。 | | creator | String | **参数解释：** 创建者账号。 **取值范围：** 不涉及。 | | description | String | **参数解释：** 描述。 **取值范围：** 不涉及。 | | grade | Number | **参数解释：** 成绩。 **取值范围：** 不涉及。 | | id | String | **参数解释：** 唯一标识。 **取值范围：** -9223372036854775808到9223372036854775807的整数。 | | kiaguid | String | **参数解释：** 关键信息资产ID。 **取值范围：** 不涉及。 | | lastUpdateTime | String | **参数解释：** 最新更新时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 **取值范围：** 不涉及。 | | modifier | String | **参数解释：** 更新者账号。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 名称。 **取值范围：** 不涉及。 | | rdmDeleteFlag | Integer | **参数解释：** 软删除标识。 **取值范围：** - 0：表示未删除。 - 1：表示已删除。 | | rdmExtensionType | String | **参数解释：** 扩展类型。 **取值范围：** 不涉及。 | | rdmVersion | Integer | **参数解释：** 系统版本。 **取值范围：** 不涉及。 | | securityLevel | String | **参数解释：** 安全密级。 **取值范围：** - internal：内部公开。 - secret：秘密。 - confidential：机密。 - top_secret：绝密。 | | tenant | [TenantViewDTO] object | **参数解释：** 租户信息。 **取值范围：** 不涉及。 | 表10TenantViewDTO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | className | String | **参数解释：** 租户对象的类名。 **取值范围：** 不涉及。 | | code | String | **参数解释：** 租户编码，用于多租户场景下的租户唯一标识。 **取值范围：** 不涉及。 | | createTime | String | **参数解释：** 租户对象的创建时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 **取值范围：** 不涉及。 | | creator | String | **参数解释：** 租户对象的创建者账号。 **取值范围：** 不涉及。 | | dataSource | String | **参数解释：** 租户使用的数据源名称，用于多租户数据隔离。 **取值范围：** 不涉及。 | | description | String | **参数解释：** 租户描述信息。 **取值范围：** 不涉及。 | | disableFlag | Boolean | **参数解释：** 租户失效标识，用于标识租户是否已失效。 **取值范围：** - true：失效。 - false：未失效（默认）。 | | id | String | **参数解释：** 租户的唯一标识。 **取值范围：** -9223372036854775808到9223372036854775807的整数。 | | kiaguid | String | **参数解释：** 租户KIA密级。 **取值范围：** 不涉及。 | | lastUpdateTime | String | **参数解释：** 租户的最后更新时间。使用UTC+0时间格式，格式为yyyy-MM-ddTHH:mm:ss.SSSZ。 **取值范围：** 不涉及。 | | modifier | String | **参数解释：** 租户的更新者账号。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 租户中文名称。 **取值范围：** 不涉及。 | | nameEn | String | **参数解释：** 租户英文名称。 **取值范围：** 不涉及。 | | rdmDeleteFlag | Integer | **参数解释：** 软删除标识。 **取值范围：** - 0：表示未删除。 - 1：表示已删除。 | | rdmExtensionType | String | **参数解释：** 租户扩展类型。 **取值范围：** 不涉及。 | | rdmVersion | Integer | **参数解释：** 租户对象的系统版本号。 **取值范围：** 不涉及。 | | securityLevel | String | **参数解释：** 租户安全密级，用于标识租户信息的安全等级。 **取值范围：** - internal：内部公开。 - secret：秘密。 - confidential：机密。 - top_secret：绝密。 | | tenant | [TenantViewDTO] object | **参数解释：** 租户信息，表示当前租户的父租户信息。 **取值范围：** 不涉及。 | 表11PageInfoViewDTO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | curPage | Integer | **参数解释：** 当前页码，标识当前返回结果所在的页数。 **取值范围：** 不涉及。 | | pageSize | Integer | **参数解释：** 每页大小，标识每页返回的记录数量。 **取值范围：** 不涉及。 | | totalRows | Integer | **参数解释：** 总行数，标识符合查询条件的总记录数。 **取值范围：** 不涉及。 | | totalPages | Integer | **参数解释：** 总页数，标识符合查询条件的总页数。 **取值范围：** 不涉及。 | #### 请求示例 **示例：按目标实例ID查询关联的关系实体（查询所有版本）** 查询目标实例ID为614786496192323584关联的关系实体数据实例，返回所有版本，分页查询第1页，每页10条。 ``` POST https://dme.cn-north-4.huaweicloud.com/rdm_04219627d6794f37ae26e8aba250415d_app/publicservices/api/RelationModel/queryRelationship/10/1 { "params" : { "role" : "TARGET", "objectId" : "614786496192323584", "isNeedTotal" : true, "latestOnly" : false } } ``` #### 响应示例 **状态码：200** OK，表示请求成功。 ``` { "result": "SUCCESS", "data": [ { "id": "614786585191260160", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": 2024-03-28T03:42:24.092+0000, "lastUpdateTime": 2024-03-28T03:42:24.092+0000, "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "RelationModel", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": 2024-03-28T03:28:34.795+0000, "lastUpdateTime": 2024-03-28T03:28:34.795+0000, "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "nameEn": null, "code": "basicTenant", "disableFlag": false, "dataSource": "DefaultDataSource" }, "className": "RelationModel", "source": { "id": "614786412419489792", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": 2024-03-28T03:41:42.900+0000, "lastUpdateTime": 2024-03-28T03:41:42.900+0000, "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Classes", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": 2024-03-28T03:28:34.795+0000, "lastUpdateTime": 2024-03-28T03:28:34.795+0000, "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "nameEn": null, "code": "basicTenant", "disableFlag": false, "dataSource": "DefaultDataSource" }, "className": "Classes", "name": "初二四班", "description": "初中二年级四班", "kiaguid": null, "securityLevel": "internal" }, "target": { "id": "614786496192323584", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": 2024-03-28T03:42:02.873+0000, "lastUpdateTime": 2024-03-28T03:42:02.873+0000, "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Student", "tenant": { "id": "-1", "creator": "xdmAdmin", "modifier": "xdmAdmin", "createTime": 2024-03-28T03:28:34.795+0000, "lastUpdateTime": 2024-03-28T03:28:34.795+0000, "rdmVersion": 1, "rdmDeleteFlag": 0, "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "kiaguid": null, "securityLevel": "internal", "nameEn": null, "code": "basicTenant", "disableFlag": false, "dataSource": "DefaultDataSource" }, "className": "Student", "name": "张三", "description": null, "kiaguid": null, "securityLevel": "internal", "grade": 98.99 }, "name": null, "description": null } ], "errors": [], "pageInfo": { "curPage": 1, "pageSize": 1000, "totalRows": 1, "totalPages": 1 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK，表示请求成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-idme/APIE-XDM-Runtime-ErrorCode.html)。