HttpRequestData - 범위 지정됨

  • 릴리스 버전: Xanadu
  • 업데이트 날짜 2024년 08월 01일
  • 읽기28분

    • HttpRequestData API는 서명을 적용하고 엔드포인트로 보내기 전에 REST 요청을 빌드하고 조작하는 메서드를 제공합니다.

    다음 순서로 이러한 API를 사용하여 아웃바운드 서명 요청을 생성합니다.
    1. HttpRequestData: API 요청을 빌드합니다.
    2. AuthCredential: 자격 증명 개체를 만들거나 기존 개체를 업데이트합니다. 자격 증명을 사용하여 RequestAuthAPI 클래스를 통해 요청에 서명합니다.
    3. RequestAuthAPI: 요청에 서명하고 HttpRequestAuthedData 개체를 반환합니다.
    4. HttpRequestAuthedData: 서명된 요청에 대한 정보를 가져옵니다.
    5. GlideHTTPRequest: 서명된 요청을 보냅니다.

    이러한 API를 사용하기 전에 요청에 서명하고 요청을 인증하는 데 사용되는 자격 증명과 연결하는 인증 알고리즘을 구성해야 합니다.

    sn_auth 네임스페이스 식별자와 함께 범위가 지정된 스크립트에서 이 API를 사용합니다. 생성자를 사용하여 이 클래스를 인스턴스화하거나 RequestAuthAPI 클래스의 getHttpRequestData() 메서드에서 HttpRequestData 객체를 반환할 수 있습니다.

    HttpRequestData - HttpRequestData()

    HttpRequestData 개체를 인스턴스화합니다.

    표 1. 매개변수
    이름 유형 설명
    없음 
    var httpRequestData = new sn_auth.HttpRequestData();

    HttpRequestData - addHeader(문자열 키, 문자열 값)

    HttpRequestData 개체에 헤더를 추가합니다.

    표 2. 매개변수
    이름 유형 설명
    키 문자열 HTTP 헤더의 이름입니다.
    값 문자열 HTTP 헤더의 값입니다.
    표 3. 반환
    유형 설명
    void

    이 예제에서는 REST 요청 페이로드를 만듭니다.

    var endpoint= "https://s3.amazonaws.com";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setService('s3');
httpRequestData.setRegion('us-east-1');
httpRequestData.setHttpMethod("PUT");
var content = "Action=SendMessage&MessageBody=This is a test message";
httpRequestData.setContent(content);
httpRequestData.addHeader('x-amz-acl', 'public-read' );

    HttpRequestData - addQueryParam(문자열 키, 문자열 값)

    HttpRequestData 개체에 쿼리 매개 변수를 추가합니다.

    표 4. 매개변수
    이름 유형 설명
    키 문자열 쿼리 매개변수의 이름입니다.
    값 문자열 쿼리 매개변수의 값입니다.
    표 5. 반환
    유형 설명
    void 
    var endpoint= "https://third-party-endpoint";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setService('s3');
httpRequestData.setRegion('us-east-1');
httpRequestData.setHttpMethod('put');
var content = "Action=SendMessage&MessageBody=This is a test message";
httpRequestData.setContent(content);
httpRequestData.addQueryParam('api_version', 'v2 );
​

    HttpRequestData - deleteHeader(문자열 키)

    HttpRequestData 개체에서 헤더를 제거합니다.

    표 6. 매개변수
    이름 유형 설명
    키 문자열 제거할 HTTP 헤더의 이름입니다.
    표 7. 반환
    유형 설명
    void 
    var endpoint= "https://s3.amazonaws.com";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setService('s3');
httpRequestData.setRegion('us-east-1');
httpRequestData.setHttpMethod('put');
var content = "Action=SendMessage&MessageBody=This is a test message";
httpRequestData.setContent(content);
httpRequestData.deleteHeader('x-amz-acl');

    HttpRequestData - getConnectionAliasID()

    REST 단계와 관련된 Integration Hub 연결 및 자격 증명 별칭의 sys_id 반환합니다.

    sys_id ConnectionInfoProvider API에 전달하여 연결에 대한 정보를 검색할 수 있습니다.
    주:
    이 메서드는 Integration Hub REST 단계에서만 사용할 수 있습니다. 자세한 내용은 REST 단계를 참조하십시오.
    표 8. 매개변수
    이름 유형 설명
    없음
    표 9. 반환
    유형 설명
    문자열 요청과 연결된 연결 및 자격 증명 별칭 [sys_alias] 테이블의 별칭 기록 Sys_id. 
    var httpRequestData = new sn_auth.HttpRequestData();
var id = httpRequestData.getConnectionAliasID();
 
var credential = new sn_cc.ConnectionInfoProvider().
var connectionInfo = credential.getConnectionInfo(id);

    HttpRequestData - getConnectionExtendedAttribute(문자열 이름)

    REST 단계와 관련된 Integration Hub 연결 및 자격 증명 별칭과 관련된 연결 속성의 값을 반환합니다.

    주:
    이 메서드는 Integration Hub REST 단계에서만 사용할 수 있습니다. 자세한 내용은 REST 단계를 참조하십시오.

    연결 속성에 대한 자세한 정보는 Integration Hub에 대한 연결 속성 작성의 내용을 참조하십시오.

    표 10. 매개변수
    이름 유형 설명
    이름 문자열 연결 속성의 이름입니다.
    표 11. 반환
    유형 설명
    문자열 연결 속성의 값입니다.

    이 예에서는 REST 단계와 관련된 연결 및 자격 증명 별칭에 설정된 연결 속성의 값을 반환합니다.

    var httpRequestData = new sn_auth.HttpRequestData();​
gs.info("API Version is: " + httpRequestData.getConnectionExtendedAttribute('api_version'));

    HttpRequestData - getContent()

    HttpRequestData 개체에서 요청 내용을 반환합니다.

    표 12. 매개변수
    이름 유형 설명
    없음
    표 13. 반환
    유형 설명
    문자열 요청의 컨텐츠입니다. 
    var endpoint= "https://s3.amazonaws.com";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setService('s3');
httpRequestData.setRegion('us-east-1');
httpRequestData.setHttpMethod('put');
var content = "Action=SendMessage&MessageBody=This is a test message";
httpRequestData.setContent(content);
httpRequestData.addHeader('x-amz-acl' , 'public-read' );
var ct = httpRequestData.getContent();

    출력:

    Action=SendMessage&MessageBody=This is a test message

    HttpRequestData - getDate()

    요청이 서명된 날짜를 반환합니다.

    표 14. 매개변수
    이름 유형 설명
    없음
    표 15. 반환
    유형 설명
    번호 1970년 1월 1일 UTC와 요청이 서명된 시점의 차이입니다.

    단위: 밀리초

    		 
    var endpoint= "https://s3.amazonaws.com";​
var httpRequestData = new sn_auth.HttpRequestData();​
httpRequestData.setEndpoint(endpoint);​
httpRequestData.addQueryParam("list-type", "2");​
httpRequestData.setService('s3');​
httpRequestData.setHttpMethod('get');​

gs.info( "Date: " + httpRequestData.getDate());

    출력:

    Date: 1349333576093

    HttpRequestData - getDirective()

    서명이 헤더의 요청에 적용되는지 또는 쿼리 매개변수로 적용되는지 여부를 반환합니다.

    기본적으로 시스템은 헤더에 서명을 적용합니다. setDirective() API를 사용하여 서명을 쿼리 매개변수로 적용할 수 있습니다.

    표 16. 매개변수
    이름 유형 설명
    없음
    표 17. 반환
    유형 설명
    문자열 서명이 헤더에 적용되는지 또는 쿼리 매개변수로 적용되는지 여부입니다.

    값은 다음과 같습니다.

    • HEADER: 서명이 요청 헤더에 적용됩니다.
    • QUERY: 서명이 쿼리 매개 변수로 적용됩니다.
    		 
    var endpoint= "https://s3.amazonaws.com";​
var httpRequestData = new sn_auth.HttpRequestData();​
httpRequestData.setEndpoint(endpoint);​
httpRequestData.addQueryParam("list-type", "2");​
httpRequestData.setService('s3');​
httpRequestData.setHttpMethod('get');​

gs.info( "Signature applied to: " + httpRequestData.getDirective() );

    출력:

    Signature applied to: HEADER

    HttpRequestData - getEndpoint()

    요청에 대해 설정된 엔드포인트를 반환합니다.

    표 18. 매개변수
    이름 유형 설명
    없음
    표 19. 반환
    유형 설명
    문자열 요청에 대해 설정된 엔드포인트입니다. 
    var endpoint= "https://s3.amazonaws.com";​
var httpRequestData = new sn_auth.HttpRequestData();​
httpRequestData.setEndpoint(endpoint);​
httpRequestData.addQueryParam("list-type", "2");​
httpRequestData.setService('s3');​
httpRequestData.setHttpMethod('get');​
httpRequestData.setDirective("query");​
​
gs.info( "Endpoint is: " + httpRequestData.getEndpoint() );

    출력:

    Endpoint is: https://s3.amazonaws.com

    HttpRequestData - getExpiry()

    RequestAuthAPI 클래스의 generateAuth() 메서드를 사용하여 요청에 서명한 시점부터 서명이 만료되기까지의 시간(초)을 반환합니다.

    만료는 일반적으로 요청을 보내는 타사 서비스에 의해 설정되며, 이는 setExpiry() 메서드에 의해 설정된 모든 값을 재정의합니다. 예를 들어, 타사 서비스에서 만료를 900초로 설정하고 setExpiry() 메서드를 사용하여 만료를 300초로 설정하면 getExpiry() 메서드는 900초를 반환합니다.

    표 20. 매개변수
    이름 유형 설명
    없음
    표 21. 반환
    유형 설명
    번호 서명이 만료되기 전의 시간입니다.

    단위: 초

    		 
    var endpoint= "https://s3.amazonaws.com";​
var httpRequestData = new sn_auth.HttpRequestData();​
httpRequestData.setEndpoint(endpoint);​
httpRequestData.addQueryParam("list-type", "2");​
httpRequestData.setService('s3');​
httpRequestData.setHttpMethod('get');​
httpRequestData.setDirective("query");​
httpRequestData.setExpiry(300);

gs.info("Signature expires in: " + httpRequestData.getExpiry());

    출력:

    Signature expires in: 300

    HttpRequestData - getHeader(문자열 키)

    지정된 HTTP 헤더와 연결된 값을 반환합니다.

    표 22. 매개변수
    이름 유형 설명
    키 문자열 HTTP 헤더의 이름입니다.
    표 23. 반환
    유형 설명
    문자열 지정된 HTTP 헤더의 값입니다. 
    var endpoint= "https://third-party-endpoint";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setService('s3');
httpRequestData.setRegion('us-east-1');
httpRequestData.setHttpMethod('put');
var content = "Action=SendMessage&MessageBody=This is a test message";
httpRequestData.setContent(content);
httpRequestData.addHeader('x-amz-acl', 'public-read' );
​

gs.info( "Header value is: " + httpRequestData.getHeader('x-amz-acl') );

    출력:

    Header value is: public-read

    HttpRequestData - getHeaderMap()

    요청에 포함된 헤더를 포함하는 객체를 반환합니다.

    표 24. 매개변수
    이름 유형 설명
    없음
    표 25. 반환
    유형 설명
    객체 요청과 연결된 모든 헤더를 정의하는 키-값 쌍입니다.

    각 키-값 쌍에는 다음 부분이 포함됩니다.

    • 키: 문자열. 헤더의 이름입니다.
    • 값: 문자열. 헤더의 값입니다.
    		 
    var endpoint= "https://third-party-endpoint";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setService('s3');
httpRequestData.setRegion('us-east-1');
httpRequestData.setHttpMethod('put');
var content = "Action=SendMessage&MessageBody=This is a test message";
httpRequestData.setContent(content);
httpRequestData.addHeader('x-amz-acl', 'public-read' );
httpRequestData.addHeader('content-type', 'application/json' );

var map = httpRequestData.getHeaderMap();

for(var x in map) {
    var y = map[x]

    gs.info(x, y);
}

    출력:

    *** Script: x-amz-acl
*** Script: content-type

    HttpRequestData - getHost()

    요청에 사용된 호스트를 반환합니다.

    표 26. 매개변수
    이름 유형 설명
    없음
    표 27. 반환
    유형 설명
    문자열 요청에 사용된 호스트입니다. 
    var endpoint= "https://third-party-endpoint";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setHost('myHost')
httpRequestData.setService('s3');
httpRequestData.setRegion('us-east-1');
httpRequestData.setHttpMethod('put');
var content = "Action=SendMessage&MessageBody=This is a test message";
httpRequestData.setContent(content);
httpRequestData.addHeader('x-amz-acl' , 'public-read' );

gs.info("Host is: " + httpRequestData.getHost());

    출력:

    Host is: myHost

    HttpRequestData - getHttpMethod()

    요청에 사용된 HTTP 메서드를 반환합니다.

    표 28. 매개변수
    이름 유형 설명
    없음
    표 29. 반환
    유형 설명
    문자열 요청에 사용되는 HTTP 메서드입니다. 
    var endpoint= "https://third-party-endpoint";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setService('s3');
httpRequestData.setRegion('us-east-1');
httpRequestData.setHttpMethod('put');
var content = "Action=SendMessage&MessageBody=This is a test message";
httpRequestData.setContent(content);
httpRequestData.addHeader('x-amz-acl', 'public-read' );
​

gs.info("HTTP method is: " + httpRequestData.getHttpMethod());

    출력:

    HTTP method is: PUT

    HttpRequestData - getQueryParam(문자열 키)

    지정된 쿼리 매개변수의 값을 반환합니다.

    표 30. 매개변수
    이름 유형 설명
    키 문자열 값을 가져올 쿼리 매개변수의 이름입니다.
    표 31. 반환
    유형 설명
    문자열 쿼리 매개변수의 값입니다. 
    var endpoint= "https://third-party-endpoint";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setService('s3');
httpRequestData.setRegion('us-east-1');
httpRequestData.setHttpMethod('put');
var content = "Action=SendMessage&MessageBody=This is a test message";
httpRequestData.setContent(content);
httpRequestData.addQueryParam('api_version', 'v2' );

gs.info("API version is: " + httpRequestData.getQueryParam('api_version'));

    출력:

    API version is: v2

    HttpRequestData - getQueryParamMap()

    요청에 포함된 쿼리 매개변수를 포함하는 객체를 반환합니다.

    표 32. 매개변수
    이름 유형 설명
    없음
    표 33. 반환
    유형 설명
    객체 요청과 연결된 쿼리 매개변수를 정의하는 키-값 쌍입니다.

    각 키-값 쌍에는 다음 부분이 포함됩니다.

    • 키: 문자열. 쿼리 매개변수의 이름입니다.
    • 값: 문자열. 쿼리 매개변수의 값입니다.
    		 
    var endpoint= "https://third-party-endpoint";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setService('s3');
httpRequestData.setRegion('us-east-1');
httpRequestData.setHttpMethod('put');
var content = "Action=SendMessage&MessageBody=This is a test message";
httpRequestData.setContent(content);
httpRequestData.addQueryParam('api_version', 'v2' );
httpRequestData.addQueryParam('limit', '1000' );
httpRequestData.addQueryParam('offset', '1' );


var map = httpRequestData.getQueryParamMap();
gs.info("api_version is: " + map['api_version']);

    출력:

    api_version is: v2

    HttpRequestData - getRegion()

    서명에 사용될 요청의 지역을 반환합니다.

    표 34. 매개변수
    이름 유형 설명
    없음
    표 35. 반환
    유형 설명
    문자열 지역의 이름입니다. 
    var endpoint= "https://third-party-endpoint";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setService('s3');
httpRequestData.setRegion('us-east-1');
httpRequestData.setHttpMethod('put');
var content = "Action=SendMessage&MessageBody=This is a test message";
httpRequestData.setContent(content);

gs.info("Region is: " + httpRequestData.getRegion());

    출력:

    Region is: us-east-1

    HttpRequestData - getService()

    요청에 정의된 서비스를 반환합니다.

    표 36. 매개변수
    이름 유형 설명
    없음
    표 37. 반환
    유형 설명
    문자열 요청에 정의된 서비스입니다. 
    var endpoint= "https://s3.amazonaws.com";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setService('s3');

gs.info("Service is: " + httpRequestData.getService());

    출력:

    Service is: s3

    HttpRequestData - setContent(문자열 내용)

    요청에서 보낼 콘텐츠를 정의합니다.

    주:
    이 메서드는 스크립트 포함 또는 MID 서버 스크립트에서 지원되지 않습니다.
    표 38. 매개변수
    이름 유형 설명
    컨텐츠 문자열 요청에서 보낼 콘텐츠입니다.
    표 39. 반환
    유형 설명
    void 
    var endpoint= "https://s3.amazonaws.com";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setService('s3');
httpRequestData.setRegion('us-east-1');
httpRequestData.setHttpMethod('put');
var content = "This is a test message";
httpRequestData.setContent(content);

    HttpRequestData - setDate(번호 날짜)

    서명에 사용되는 요청의 날짜를 정의합니다.

    타임스탬프를 기반으로 서명이 올바르게 만들어졌는지 여부를 테스트할 때만 이 방법을 사용합니다. 프로덕션에서 서명 요청은 서명을 생성한 시간을 사용합니다. 이 값을 수동으로 설정하면 서명 요청이 실패할 수 있습니다.

    표 40. 매개변수
    이름 유형 설명
    날짜 번호 1970년 1월 1일 UTC와 요청에 서명하는 데 사용된 날짜 간의 차이입니다.

    단위: 밀리초
    표 41. 반환
    유형 설명
    void 
    var endpoint= "https://s3.amazonaws.com";​
var httpRequestData = new sn_auth.HttpRequestData();​
httpRequestData.setEndpoint(endpoint);​
httpRequestData.addQueryParam("list-type", "2");​
httpRequestData.setService('s3');​
httpRequestData.setHttpMethod('get');
httpRequestData.setDate(1349333576093);

    HttpRequestData - setDirective(문자열 지시문)

    헤더에서 요청에 서명을 적용할지 또는 쿼리 매개변수로 적용할지 정의합니다.

    표 42. 매개변수
    이름 유형 설명
    지시문 문자열 서명을 헤더에 적용할지 또는 쿼리 매개변수로 적용할지 여부입니다.

    값은 다음과 같습니다.

    • query: signature를 쿼리 매개 변수로 적용합니다.
    • header: 요청 헤더에 서명을 적용합니다.

    기본값: 헤더
    표 43. 반환
    유형 설명
    void 
    var endpoint= "https://s3.amazonaws.com";​
var httpRequestData = new sn_auth.HttpRequestData();​
httpRequestData.setEndpoint(endpoint);​
httpRequestData.addQueryParam("list-type", "2");​
httpRequestData.setService('s3');​
httpRequestData.setHttpMethod('get');​
httpRequestData.setDirective("query");​

    HttpRequestData - setEndpoint(문자열 엔드포인트)

    요청을 보낼 엔드포인트를 정의합니다.

    표 44. 매개변수
    이름 유형 설명
    endpoint 문자열 요청을 보낼 엔드포인트입니다. 엔드포인트에는 쿼리 매개 변수, 경로 및 버전이 포함될 수 있습니다.
    표 45. 반환
    유형 설명
    void 
    var endpoint="https://third-party-endpoint/path-parameters/version";

var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);

    HttpRequestData - setExpiry(번호 만료)

    RequestAuthAPI 클래스의 generateAuth() 메서드를 사용하여 요청에 서명한 시점부터 서명이 만료되기까지의 시간을 설정합니다.

    만료는 일반적으로 요청을 보내는 타사 서비스에 의해 설정되며, 이는 setExpiry() 메서드에 의해 설정된 모든 값을 재정의합니다. 예를 들어, 타사 서비스에서 만료를 900초로 설정하고 setExpiry() 메서드를 사용하여 만료를 300초로 설정하면 getExpiry() 메서드는 900초를 반환합니다.

    표 46. 매개변수
    이름 유형 설명
    만료 번호 서명이 만료되기 전까지의 시간입니다.

    단위: 초
    표 47. 반환
    유형 설명
    void 
    var endpoint= "https://s3.amazonaws.com";​
var httpRequestData = new sn_auth.HttpRequestData();​
httpRequestData.setEndpoint(endpoint);​
httpRequestData.addQueryParam("list-type", "2");​
httpRequestData.setService('s3');​
httpRequestData.setHttpMethod('get');​
httpRequestData.setExpiry(300);​

    HttpRequestData - setHost(문자열 호스트)

    요청에 사용되는 호스트를 정의합니다.

    표 48. 매개변수
    이름 유형 설명
    호스트 문자열 HTTP 요청 호스트의 이름입니다.
    표 49. 반환
    유형 설명
    void 
    var endpoint= "https:third-party-endpoint";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setHost('myHost')
httpRequestData.setService('s3');
httpRequestData.setRegion('us-east-1');
httpRequestData.setHttpMethod('put');
var content = "Action=SendMessage&MessageBody=This is a test message";
httpRequestData.setContent(content);
httpRequestData.addHeader('x-amz-acl', 'public-read' );

    HttpRequestData - setHttpMethod(문자열 httpMethod)

    요청에 사용할 HTTP 메서드를 설정합니다.

    표 50. 매개변수
    이름 유형 설명
    http메서드 문자열 요청에 사용할 HTTP 메서드입니다.
    표 51. 반환
    유형 설명
    void 
    var endpoint= "https://third-party-endpoint";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setService('s3');
httpRequestData.setRegion('us-east-1');
httpRequestData.setHttpMethod('put');

    HttpRequestData - setRegion(문자열 영역)

    서명 시 요청에 사용할 지역을 정의합니다.

    표 52. 매개변수
    이름 유형 설명
    region 문자열 요청에 서명하는 데 사용할 지역입니다. 사용 가능한 값은 타사 API의 요구 사항에 따라 결정됩니다.
    표 53. 반환
    유형 설명
    void 
    var endpoint= "https:third-party-endpoint";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setService('s3');
httpRequestData.setRegion('us-east-1');
httpRequestData.setHttpMethod('put');
var content = "Action=SendMessage&MessageBody=This is a test message";
httpRequestData.setContent(content);

    HttpRequestData - setService(문자열 서비스)

    요청에 대한 서비스를 정의합니다.

    표 54. 매개변수
    이름 유형 설명
    서비스 문자열 요청에 대한 서비스입니다.
    표 55. 반환
    유형 설명
    void 
    var endpoint= "https://s3.amazonaws.com";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setService('s3');