DsgSceneQuerySceneListByName -

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	DsgSceneQuerySceneListByName	系統規定參數。取值：DsgSceneQuerySceneListByName。
SceneName	String	否	dev_	脫敏情境名稱的模糊查詢關鍵字，平台會根據該關鍵字擷取相關脫敏情境資訊。

返回資料

名稱	類型	樣本值	描述
Success	Boolean	true	調用是否成功。取值如下： true：調用成功。 false：調用失敗。
ErrorCode	String	1029030003	錯誤碼。
ErrorMessage	String	param error	錯誤資訊。
HttpStatusCode	Integer	400	HTTP狀態代碼。
Data	Array of Datas		返回資料。
Id	Long	123	脫敏情境ID。
SceneCode	String	dataworks_display_desense_code	一級脫敏情境Code。取值如下：資料開發/資料地圖展示脫敏：dataworks_display_desense_code MaxCompute引擎層脫敏：maxcompute_desense_code MaxCompute引擎層脫敏（新）：maxcompute_new_desense_code Hologres引擎層脫敏：hologres_display_desense_code Data Integration靜態脫敏：dataworks_data_integration_desense_code 資料分析展示脫敏：dataworks_analysis_desense_code
Desc	String	測試用情境	脫敏情境描述資訊。
SceneName	String	test_scene	脫敏情境名稱。
UserGroups	String	user1,user2	脫敏情境的使用者組名稱列表。使用英文逗號（,）隔開。
SceneLevel	Integer	1	脫敏情境層級。取值如下： 0：一級情境 1：二級情境
Projects	Array of Project		脫敏情境生效的引擎資訊。
DbType	String	ODPS.ODPS	引擎類型。取值如下： ODPS：ODPS.ODPS HOLO：HOLO.POSTGRES EMR：EMR
ProjectName	String	dev_project	引擎執行個體名稱。
ClusterId	String	c-1234	EMR叢集ID。僅當脫敏情境生效的資料範圍為EMR引擎時，會返回該參數。
Children	Array of Any	$ref	若存在多級脫敏情境（即脫敏情境存在父子節點嵌套），則此處為嵌套的脫敏情境資訊。參數與外層參數相同。
RequestId	String	102400001	請求的ID。用於定位日誌，排查問題。

樣本

請求樣本

http(s)://[Endpoint]/?Action=DsgSceneQuerySceneListByName
&SceneName=dev_
&公用請求參數

正常返回樣本

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DsgSceneQuerySceneListByNameResponse>
    <Success>true</Success>
    <ErrorCode>1029030003</ErrorCode>
    <ErrorMessage>param error</ErrorMessage>
    <HttpStatusCode>400</HttpStatusCode>
    <Data>
        <Id>123</Id>
        <SceneCode>dataworks_display_desense_code</SceneCode>
        <Desc>測試用情境</Desc>
        <SceneName>test_scene</SceneName>
        <UserGroups>user1,user2</UserGroups>
        <SceneLevel>1</SceneLevel>
        <Projects>
            <DbType>ODPS.ODPS</DbType>
            <ProjectName>dev_project</ProjectName>
            <ClusterId>c-1234</ClusterId>
        </Projects>
        <Children>$ref</Children>
    </Data>
    <RequestId>102400001</RequestId>
</DsgSceneQuerySceneListByNameResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Success" : true,
  "ErrorCode" : "1029030003",
  "ErrorMessage" : "param error",
  "HttpStatusCode" : 400,
  "Data" : [ {
    "Id" : 123,
    "SceneCode" : "dataworks_display_desense_code",
    "Desc" : "測試用情境",
    "SceneName" : "test_scene",
    "UserGroups" : "user1,user2",
    "SceneLevel" : 1,
    "Projects" : [ {
      "DbType" : "ODPS.ODPS",
      "ProjectName" : "dev_project",
      "ClusterId" : "c-1234"
    } ],
    "Children" : [ "$ref" ]
  } ],
  "RequestId" : "102400001"
}

錯誤碼

HttpCode	錯誤碼	錯誤資訊	描述
400	DESENSSCENE.ID.ERROR	The desensitization scenario ID does not match or does not exist with the tenant.	情境ID不存在或不屬於該租戶。
400	DESENSSCENE.IDLEVEL.ERROR	The desensitization scenario is not a secondary scenario.	脫敏情境不是二級情境。
400	DESENSSCENE.PROJECT.ERROR	The project space does not exist.	工作空間不存在。
400	DESENSSCENE.SIZE.ERROR	The number of desens scene exceeds the limit.	脫敏情境數量超限。
400	DESENSSCENE.UESRGROUP.ERROR	The user group ID does not match the tenant or does not exist.	使用者組ID不存在或不屬於該租戶。
400	PARAMS.ERROR	param error.	參數錯誤。
403	PERMISSION.DENIED.ERROR	Permission denied	許可權不足。
500	UNKNOWN.ERROR	unknown error.	未知錯誤。

訪問錯誤中心查看更多錯誤碼。