콘텐츠로 이동

RUM 구성 빠르게 나열



GET /api/v1/rum_cfg/quick_list

개요

현재 워크스페이스 RUM 앱의 식별자와 콘텐츠 요약 목록을 나열합니다.

호출 전 및 사용 단계

현재 Key 권한은 routine.defaultAccess, rum.rumCfgManage, anonymous.shared, anonymous.snapshotShared 중 하나를 충족해야 하며, 인증은 계속 실제 OpenAPI ID를 기준으로 수행됩니다. 현재 워크스페이스는 Key로 결정되며, Query 워크스페이스 목록으로 범위를 확장할 수 없습니다.

삭제되지 않은 앱의 uuid/appId/jsonContent/workspaceUUID만 반환하며, Token, mapping 상태, 통계, 대시보드 바인딩 또는 페이지네이션은 반환하지 않습니다. uuid는 appId의 별칭이며 실제 내부 구성 UUID가 아닙니다. appId는 쉼표로 구분하여 필터링합니다. 생략하거나 빈 값이면 전체를 반환하고, 일치 항목이 없으면 []를 반환합니다. 순서는 보장되지 않습니다. 이 OpenAPI는 내부 경량 목록 메서드를 호출하며, 프런트엔드 quick_list의 데이터 액세스 필터링/통계 반환 규약을 적용할 수 없습니다.

요청 헤더

매개변수 이름 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예: <DF-API-KEY>
가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

Query 요청 매개변수

매개변수 이름 유형 필수 설명
appId commaArray 선택적 쉼표 구분 앱 식별자입니다. 전체 문자열의 앞뒤 공백을 제거한 후 쉼표로 분리하며, 각 항목은 개별적으로 trim하지 않습니다. 구분자 옆에 공백을 추가하지 마십시오. 생략하거나 빈 값이면 삭제되지 않은 모든 앱을 조회합니다.
null 허용: False
예: payment_web,payment_mobile
가져오기 또는 입력 방법: RUM 앱 요약 목록에서 content[].appId를 가져오거나(uuid가 동일한 값임), 현재 워크스페이스의 RUM 앱 설정에서 가져옵니다.

매개변수 추가 설명

content[].uuid는 appId와 동일합니다. 이 API는 Client Token 또는 RUM mapping 준비 상태를 제공하지 않습니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/rum_cfg/quick_list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode appId=payment_web

응답

HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.

필드 유형 설명
content array<object> 앱 요약 목록 배열이며, 일치 항목이 없으면 []이고 페이지네이션하지 않습니다.
content[].uuid string 공개 호환 별칭이며 항상 appId와 같고, 내부 실제 RumCfg UUID가 아닙니다.
content[].appId string SDK/쿼리에서 사용하는 앱 식별자입니다.
content[].workspaceUUID string 소속 워크스페이스 UUID입니다.
content[].jsonContent object 앱 콘텐츠 객체입니다.
content[].jsonContent.name string 앱 표시 이름입니다.
content[].jsonContent.type string web/miniapp/android/ios/custom/reactnative/harmonyos.
content[].jsonContent.extend object 선택적으로 저장되는 동적 확장이며, 없으면 이 키를 생략할 수 있습니다.
content[].jsonContent.extend.사용자 정의 키 JSON 호출자가 저장한 확장 키/값이며, 서버가 추가 실행 매개변수를 지원함을 의미하지 않습니다.
content[].declaration object 현재 워크스페이스의 공통 선언입니다.
{
  "code": 200,
  "content": [
    {
      "uuid": "payment_web",
      "appId": "payment_web",
      "workspaceUUID": "wksp_example",
      "jsonContent": {
        "name": "支付Web",
        "type": "web",
        "extend": {
          "team": "payment"
        }
      },
      "declaration": {}
    }
  ],
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하십시오.

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 선언되지 않은 Query 매개변수를 사용했거나 매개변수가 규칙을 위반함 매개변수 파싱 실패 Query 매개변수 표 및 예시를 확인하십시오.
500 ft.InternalServerError 데이터베이스 읽기 또는 기존 jsonContent 구조 이상 내부 오류 traceId를 보관하고 백오프 후 재시도하십시오. 계속 실패하면 관리자에게 앱 구성을 확인하도록 요청하십시오.

문서 평가

이 페이지가 도움이 되었나요?